Home Reference Source
import Events from 'oxygen-core/utils/Events.js'
public class | source

Events

Events emitter.

Example:

const events = new Events();
events.on('hello', wat => console.log(wat));
events.trigger('hello', 'world');
events.off('hello');
events.dispose();

Constructor Summary

Public Constructor
public

Constructor.

Method Summary

Public Methods
public

Destructor (disposes internal resources).

public

off(name: string, callback: Function)

Remove given callback from listeners of given event.

public

on(name: string, callback: Function)

Listen for given event.

public

trigger(name: string, args: ...*)

Triggers given event with given callback parameters.

public

triggerLater(name: string, args: ...*)

Triggers given event with given callback parameters on next execution frame (delayed).

Public Constructors

public constructor() source

Constructor.

Public Methods

public dispose() source

Destructor (disposes internal resources).

Example:

events.dispose();
events = null;

public off(name: string, callback: Function) source

Remove given callback from listeners of given event. If callback is omitted, then all callbacks of given event are removed.

Params:

NameTypeAttributeDescription
name string

Event name.

callback Function

Event callback.

Example:

const cb = wat => console.log(wat);
events.on('hello', cb);
events.off('hello', cb); // remove callback.
events.off('hello'); // remove all callbacks.

public on(name: string, callback: Function) source

Listen for given event.

Params:

NameTypeAttributeDescription
name string

Event name.

callback Function

Event callback. Arguments are passed here from trigger methods.

Example:

events.on('hello', wat => console.log(wat));
events.trigger('hello', 'world');

public trigger(name: string, args: ...*) source

Triggers given event with given callback parameters.

Params:

NameTypeAttributeDescription
name string

Event name.

args ...*

Event parameters.

Example:

events.on('hello', wat => console.log(wat));
events.trigger('hello', 'world');

public triggerLater(name: string, args: ...*) source

Triggers given event with given callback parameters on next execution frame (delayed).

Params:

NameTypeAttributeDescription
name string

Event name.

args ...*

Event parameters.

Example:

events.on('hello', wat => console.log(wat));
events.triggerLater('hello', 'world');