kotlin-cesium-engine/cesium.engine/Event

Event

external class Event<Listener : Function<Unit>>(source)

A generic utility class for managing subscribers for a particular event. This class is usually instantiated inside of a container class and exposed as a property for others to subscribe to.

MyObject.prototype.myListener = function(arg1, arg2) {
    this.myArg1Copy = arg1;
    this.myArg2Copy = arg2;
}

const myObjectInstance = new MyObject();
const evt = new Event();
evt.addEventListener(MyObject.prototype.myListener, myObjectInstance);
evt.raiseEvent('1', '2');
evt.removeEventListener(MyObject.prototype.myListener);
Content copied to clipboard

See also

Constructors

Link copied to clipboard
constructor()

Properties

Link copied to clipboard
val numberOfListeners: Int

The number of listeners currently subscribed to the event.

Functions

Link copied to clipboard
fun addEventListener(listener: Listener, scope: Any? = definedExternally): RemoveCallback

Registers a callback function to be executed whenever the event is raised. An optional scope can be provided to serve as the this pointer in which the function will execute.

Link copied to clipboard
fun raiseEvent(vararg arguments: Any)

Raises the event by calling each registered listener with all supplied arguments.

Link copied to clipboard
fun removeEventListener(listener: Listener, scope: Any? = definedExternally): Boolean

Unregisters a previously registered callback.