mirror of
https://github.com/photonstorm/phaser
synced 2024-12-25 12:33:38 +00:00
35 lines
1.5 KiB
JavaScript
35 lines
1.5 KiB
JavaScript
|
/**
|
||
|
|
* @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 Down Input Event.
|
||
|
|
*
|
||
|
|
* This event is dispatched by the Input Plugin belonging to a Scene if a pointer is pressed down on _any_ interactive Game Object.
|
||
|
|
*
|
||
|
|
* Listen to this event from within a Scene using: `this.input.on('gameobjectdown', listener)`.
|
||
|
|
*
|
||
|
|
* To receive this event, the Game Objects must have been set as interactive.
|
||
|
|
* See [GameObject.setInteractive]{Phaser.GameObjects.GameObject#setInteractive} for more details.
|
||
|
|
*
|
||
|
|
* To listen for this event from a _specific_ Game Object, use the [GAMEOBJECT_POINTER_DOWN event]{Phaser.Input.Events#GAMEOBJECT_POINTER_DOWN} instead.
|
||
|
|
*
|
||
|
|
* The event hierarchy is as follows:
|
||
|
|
*
|
||
|
|
* 1) GAMEOBJECT_POINTER_DOWN
|
||
|
|
* 2) GAMEOBJECT_DOWN
|
||
|
|
* 3) POINTER_DOWN or POINTER_DOWN_OUTSIDE
|
||
|
|
*
|
||
|
|
* 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_DOWN
|
||
|
|
*
|
||
|
|
* @param {Phaser.Input.Pointer} pointer - The Pointer responsible for triggering this event.
|
||
|
|
* @param {Phaser.GameObjects.GameObject} gameObject - The Game Object the pointer was pressed down on.
|
||
|
|
* @param {Phaser.Input.EventData} event - The Phaser input event. You can call `stopPropagation()` to halt it from going any further in the event flow.
|
||
|
|
*/
|
||
|
|
module.exports = 'gameobjectdown';
|