/
POINTER_DOWN_OUTSIDE_EVENT.js
28 lines (27 loc) · 1.18 KB
/
POINTER_DOWN_OUTSIDE_EVENT.js
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
/**
* @author Richard Davey <rich@photonstorm.com>
* @copyright 2020 Photon Storm Ltd.
* @license {@link https://opensource.org/licenses/MIT|MIT License}
*/
/**
* The Pointer Down Outside Input Event.
*
* This event is dispatched by the Input Plugin belonging to a Scene if a pointer is pressed down anywhere outside of the game canvas.
*
* Listen to this event from within a Scene using: `this.input.on('pointerdownoutside', listener)`.
*
* 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}
*
* 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_DOWN_OUTSIDE
* @since 3.16.1
*
* @param {Phaser.Input.Pointer} pointer - The Pointer responsible for triggering this event.
*/
module.exports = 'pointerdownoutside';