The Pointer Out Input Event.
This event is dispatched by the Input Plugin belonging to a Scene if a pointer moves out of any interactive Game Object.
Listen to this event from within a Scene using: this.input.on('pointerout', listener)
.
The event hierarchy is as follows:
With the top event being dispatched first and then flowing down the list. Note that higher-up event handlers can stop the propagation of this event.
If the pointer leaves the game canvas itself, it will not trigger an this event. To handle those cases,
please listen for the GAME_OUT
event.
name | type | description |
---|---|---|
pointer | Phaser.Input.Pointer |
The Pointer responsible for triggering this event. |
justOut | Array.<Phaser.GameObjects.GameObject> |
An array containing all interactive Game Objects that the pointer moved out of when the event was created. |