2019-01-16 13:12:07 +00:00
|
|
|
/**
|
|
|
|
* @author Richard Davey <rich@photonstorm.com>
|
2020-01-15 12:07:09 +00:00
|
|
|
* @copyright 2020 Photon Storm Ltd.
|
2019-05-10 15:15:04 +00:00
|
|
|
* @license {@link https://opensource.org/licenses/MIT|MIT License}
|
2019-01-16 13:12:07 +00:00
|
|
|
*/
|
|
|
|
|
|
|
|
/**
|
|
|
|
* 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.
|
|
|
|
*
|
2019-11-26 10:33:29 +00:00
|
|
|
* Listen to this event from within a Scene using: `this.input.on('pointerout', listener)`.
|
2019-01-16 13:12:07 +00:00
|
|
|
*
|
|
|
|
* The event hierarchy is as follows:
|
|
|
|
*
|
2019-01-18 15:20:56 +00:00
|
|
|
* 1. [GAMEOBJECT_POINTER_OUT]{@linkcode Phaser.Input.Events#event:GAMEOBJECT_POINTER_OUT}
|
|
|
|
* 2. [GAMEOBJECT_OUT]{@linkcode Phaser.Input.Events#event:GAMEOBJECT_OUT}
|
|
|
|
* 3. [POINTER_OUT]{@linkcode Phaser.Input.Events#event:POINTER_OUT}
|
2019-01-16 13:12:07 +00:00
|
|
|
*
|
|
|
|
* 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.
|
|
|
|
*
|
|
|
|
* @event Phaser.Input.Events#POINTER_OUT
|
2019-02-12 11:37:58 +00:00
|
|
|
* @since 3.0.0
|
2019-01-16 13:12:07 +00:00
|
|
|
*
|
|
|
|
* @param {Phaser.Input.Pointer} pointer - The Pointer responsible for triggering this event.
|
|
|
|
* @param {Phaser.GameObjects.GameObject[]} justOut - An array containing all interactive Game Objects that the pointer moved out of when the event was created.
|
|
|
|
*/
|
|
|
|
module.exports = 'pointerout';
|