Type class
An EventDispatcher
for Sprite
.
Click here for more info
Sources
This information about SpriteEventDispatcher is provided for reference only and is not available through exported packages and thus should not be imported or used on its own.
Inheritance
SpriteEventDispatcher extends EventDispatcher
.
SpriteEventDispatcher is not extended by any other symbol.
Settings
SpriteEventDispatcher does not have any settings.
Private settings
SpriteEventDispatcher does not have any private settings.
Properties
SpriteEventDispatcher does not have any properties.
Methods
constructor( sprite: ) |
Returns |
---|---|
disable() |
Returns Inherited from Disable dispatching of events until re-enabled by |
disableType( type: ) |
Returns Inherited from Disable dispatching of events for a certain event type. Optionally, can set how many dispatches to skip before automatically re-enabling the dispatching. |
dispatch( type: ) |
Returns Inherited from Dispatches an event immediately without waiting for next cycle. @todo automatically add in type and target properties if they are missing |
dispose() |
Returns Inherited from Dispose (destroy) this object. |
enable() |
Returns Inherited from Enable dispatching of events if they were previously disabled by |
enableType( type: ) |
Returns Inherited from Enable dispatching particular event, if it was disabled before by |
has( type: ) |
Returns Inherited from Checks if there's already a listener with specific parameters. |
hasListeners() |
Returns Inherited from Checks if this particular event dispatcher has any listeners set. |
hasListenersByType( type: ) |
Returns Inherited from Checks if this particular event dispatcher has any particular listeners set. |
isDisposed() |
Returns Inherited from Returns if this object has been already disposed. |
isEnabled( type: ) |
Returns Inherited from Checks if dispatching for particular event type is enabled. |
off( type: ) |
Returns Inherited from Removes the event listener with specific parameters. |
on( type: ) |
Returns Inherited from Creates an event listener to be invoked on a specific event type. button.events.once("click", (ev) => { console.log("Button clicked"); }, this); button.events.once("click", (ev) => { console.log("Button clicked"); }, this); The above will invoke our custom event handler whenever series we put event on is hidden. |
onAll( callback: ( this: ) |
Returns Inherited from Creates an event listener to be invoked on any event. |
once( type: ) |
Returns Inherited from Creates an event listener to be invoked on a specific event type once. Once the event listener is invoked, it is automatically disposed. button.events.once("click", (ev) => { console.log("Button clicked"); }, this); button.events.once("click", (ev) => { console.log("Button clicked"); }, this); The above will invoke our custom event handler the first time series we put event on is hidden. |
removeType( type: ) |
Returns Inherited from Removes all listeners of a particular event type |
stopParentDispatch() |
Returns Will stop any bubbling up of the event to element's parents. Should be called in an event handler, e.g.: element.events.on("pointerdown", function(ev) { // Do something here and prevent from "pointerdown" bubbling up // ... ev.target.events.stopParentDispatch(); }); element.events.on("pointerdown", function(ev) { // Do something here and prevent from "pointerdown" bubbling up // ... ev.target.events.stopParentDispatch(); }); |
There are 16 inherited items currently hidden from this list. |
Events
SpriteEventDispatcher does not have any events.