phaser/src/input/events/GAMEOBJECT_POINTER_DOWN_EVENT.js

36 lines
1.9 KiB
JavaScript
Raw Normal View History

2019-01-16 12:13:30 +00:00
/**
* @author Richard Davey <rich@photonstorm.com>
* @copyright 2019 Photon Storm Ltd.
* @license {@link https://github.com/photonstorm/phaser/blob/master/license.txt|MIT License}
*/
/**
* The Game Object Pointer Down Event.
*
* This event is dispatched by an interactive Game Object if a pointer is pressed down on it.
*
* Listen to this event from a Game Object using: `gameObject.on('pointerdown', listener)`.
* Note that the scope of the listener is automatically set to be the Game Object instance itself.
*
* To receive this event, the Game Object must have been set as interactive.
* See [GameObject.setInteractive]{@link Phaser.GameObjects.GameObject#setInteractive} for more details.
2019-01-16 12:13:30 +00:00
*
* The event hierarchy is as follows:
*
* 1. [GAMEOBJECT_POINTER_DOWN]{@linkcode Phaser.Input.Events#event:GAMEOBJECT_POINTER_DOWN}
* 2. [GAMEOBJECT_DOWN]{@linkcode Phaser.Input.Events#event:GAMEOBJECT_DOWN}
* 3. [POINTER_DOWN]{@linkcode Phaser.Input.Events#event:POINTER_DOWN} or [POINTER_DOWN_OUTSIDE]{@linkcode Phaser.Input.Events#event:POINTER_DOWN_OUTSIDE}
2019-01-16 12:13:30 +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#GAMEOBJECT_POINTER_DOWN
* @since 3.0.0
2019-01-16 12:13:30 +00:00
*
* @param {Phaser.Input.Pointer} pointer - The Pointer responsible for triggering this event.
* @param {number} localX - The x coordinate that the Pointer interacted with this object on, relative to the Game Object's top-left position.
* @param {number} localY - The y coordinate that the Pointer interacted with this object on, relative to the Game Object's top-left position.
2019-02-13 14:17:36 +00:00
* @param {Phaser.Input.Types.EventData} event - The Phaser input event. You can call `stopPropagation()` to halt it from going any further in the event flow.
2019-01-16 12:13:30 +00:00
*/
module.exports = 'pointerdown';