new Events(sprite)
The Events component is a collection of events fired by the parent game object.
For example to tell when a Sprite has been added to a new group:
sprite.events.onAddedToGroup.add(yourFunction, this);
Where yourFunction is the function you want called when this event occurs.
Note that the Input related events only exist if the Sprite has had inputEnabled set to true.
Parameters:
| Name | Type | Description |
|---|---|---|
sprite |
Phaser.Sprite | A reference to the Sprite that owns this Events object. |
- Source:
Members
-
onAddedToGroup
-
- Source:
Properties:
Name Type Description onAddedToGroupPhaser.Signal This signal is dispatched when the parent is added to a new Group.
-
onAnimationComplete
-
- Default Value:
- null
- Source:
Properties:
Name Type Description onAnimationCompletePhaser.Signal This signal is dispatched when the parent has an animation that finishes playing.
-
onAnimationLoop
-
- Default Value:
- null
- Source:
Properties:
Name Type Description onAnimationLoopPhaser.Signal This signal is dispatched when the parent has an animation that loops playback.
-
onAnimationStart
-
- Default Value:
- null
- Source:
Properties:
Name Type Description onAnimationStartPhaser.Signal This signal is dispatched when the parent has an animation that is played.
-
onDestroy
-
- Source:
Properties:
Name Type Description onDestroyPhaser.Signal This signal is dispatched when the parent is destoyed.
-
onDragStart
-
- Default Value:
- null
- Source:
Properties:
Name Type Description onDragStartPhaser.Signal This signal is dispatched if the parent is inputEnabled and receives a drag start event from a Pointer.
-
onDragStop
-
- Default Value:
- null
- Source:
Properties:
Name Type Description onDragStopPhaser.Signal This signal is dispatched if the parent is inputEnabled and receives a drag stop event from a Pointer.
-
onEnterBounds
-
- Source:
Properties:
Name Type Description onEnterBoundsPhaser.Signal This signal is dispatched when the parent returns within the world bounds (only if Sprite.checkWorldBounds is true).
-
onInputDown
-
- Default Value:
- null
- Source:
Properties:
Name Type Description onInputDownPhaser.Signal This signal is dispatched if the parent is inputEnabled and receives a down event from a Pointer.
-
onInputOut
-
- Default Value:
- null
- Source:
Properties:
Name Type Description onInputOutPhaser.Signal This signal is dispatched if the parent is inputEnabled and receives an out event from a Pointer.
-
onInputOver
-
- Default Value:
- null
- Source:
Properties:
Name Type Description onInputOverPhaser.Signal This signal is dispatched if the parent is inputEnabled and receives an over event from a Pointer.
-
onInputUp
-
- Default Value:
- null
- Source:
Properties:
Name Type Description onInputUpPhaser.Signal This signal is dispatched if the parent is inputEnabled and receives an up event from a Pointer.
-
onKilled
-
- Source:
Properties:
Name Type Description onKilledPhaser.Signal This signal is dispatched when the parent is killed.
-
onOutOfBounds
-
- Source:
Properties:
Name Type Description onOutOfBoundsPhaser.Signal This signal is dispatched when the parent leaves the world bounds (only if Sprite.checkWorldBounds is true).
-
onRemovedFromGroup
-
- Source:
Properties:
Name Type Description onRemovedFromGroupPhaser.Signal This signal is dispatched when the parent is removed from a Group.
-
onRevived
-
- Source:
Properties:
Name Type Description onRevivedPhaser.Signal This signal is dispatched when the parent is revived.
-
parent
-
- Source:
Properties:
Name Type Description parentPhaser.Sprite The Sprite that owns these events.