DynamicEvents

View source
ceramic.Entity → tracker.DynamicEvents (Class)
Implements: ceramic.Component

Fire and listen to dynamic events. Works similarly to static events, but dynamic. If you can know the event names at compile time, using static events (@event function myEvent();) is preferred.

Instance Members

initializerName: String
emit(event: tracker.DynamicEvents.T, ?args: Array<Dynamic>): Void
Name Type Default
event tracker.DynamicEvents.T
args Array<Dynamic> (optional)
on(event: tracker.DynamicEvents.T, owner: Null<ceramic.Entity>, cb: Dynamic): Void
Name Type
event tracker.DynamicEvents.T
owner Null<ceramic.Entity>
cb Dynamic
once(event: tracker.DynamicEvents.T, owner: Null<ceramic.Entity>, cb: Dynamic): Void
Name Type
event tracker.DynamicEvents.T
owner Null<ceramic.Entity>
cb Dynamic
off(event: tracker.DynamicEvents.T, ?cb: Dynamic): Void
Name Type Default
event tracker.DynamicEvents.T
cb Dynamic (optional)
listens(event: tracker.DynamicEvents.T): Bool
Name Type
event tracker.DynamicEvents.T
Returns
Bool
new(): Void

Private Members

dispatcher: EventDispatcher
mapping: Map
nextIndex: Int
bindAsComponent(): Void
eventToString(event: tracker.DynamicEvents.T): String
Name Type
event tracker.DynamicEvents.T
Returns
String
indexForEvent(event: tracker.DynamicEvents.T): Int
Name Type
event tracker.DynamicEvents.T
Returns
Int
setEntity(entity: ceramic.Entity): Void
Name Type
entity ceramic.Entity
getEntity(): ceramic.Entity
Returns
ceramic.Entity

Metadata

Name Parameters
:build ceramic.macros.ComponentMacro.build()
:autoBuild ceramic.macros.ComponentMacro.build()
:build ceramic.macros.EntityMacro.buildForCompletion()
:autoBuild ceramic.macros.EntityMacro.buildForCompletion()
:build tracker.macros.EventsMacro.build()
:autoBuild tracker.macros.EventsMacro.build()