Only set when serializing.
Inversion-of-control versions of on
. Tell this object to listen to
an event in another object... keeping track of what it's listening to
for easier unbinding later.
Optional
callback: EventCallbackOptional
priority: numberInversion-of-control versions of once
.
Optional
priority: numberRemove one or many callbacks. If context
is null, removes all
callbacks with that function. If callback
is null, removes all
callbacks for the event. If name
is null, removes all bound
callbacks for all events.
Optional
context: anyOptional
callback: EventCallbackOptional
context: anyBind an event to a callback
function. Passing "all"
will bind
the callback to all events fired.
Optional
context: anyOptional
callback: EventCallbackOptional
context: anyOptional
priority: numberOptional
context: anyOptional
priority: numberBind an event to only be triggered a single time. After the first time the callback is invoked, its listener will be removed. If multiple events are passed in using the space-separated syntax, the handler will fire once for each event, not once for a combination of all events.
Optional
context: anyOptional
context: anyOptional
priority: anySame as toObject but emits Serializer.EVENT_BEGIN and Serializer.EVENT_END events.
Tell this object to stop listening to either specific events ... or to every object it's currently listening to.
Optional
obj: EventDispatcherOptional
name: string | EventMapOptional
callback: EventCallbackTrigger one or many events, firing all bound callbacks. Callbacks are
passed the same arguments as trigger
is, apart from the event name
(unless you're listening on "all"
, which will cause your callback to
receive the true name of the event as the first argument).
Static
EVENT_Triggered when the Serializer begins transforming a project. EVENT_BEGIN
Static
EVENT_Triggered when the Serializer has finished transforming a project. EVENT_END
Generated using TypeDoc
A class that provides a custom event channel.
You may bind a callback to an event with
on
or remove withoff
;trigger
-ing an event fires all callbacks in succession.