-
Notifications
You must be signed in to change notification settings - Fork 7.1k
/
DRAG_START_EVENT.js
25 lines (24 loc) · 981 Bytes
/
DRAG_START_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
/**
* @author Richard Davey <rich@phaser.io>
* @copyright 2013-2024 Phaser Studio Inc.
* @license {@link https://opensource.org/licenses/MIT|MIT License}
*/
/**
* The Pointer Drag Start Input Event.
*
* This event is dispatched by the Input Plugin belonging to a Scene if a pointer starts to drag any Game Object.
*
* Listen to this event from within a Scene using: `this.input.on('dragstart', listener)`.
*
* A Pointer can only drag a single Game Object at once.
*
* To listen for this event from a _specific_ Game Object, use the [GAMEOBJECT_DRAG_START]{@linkcode Phaser.Input.Events#event:GAMEOBJECT_DRAG_START} event instead.
*
* @event Phaser.Input.Events#DRAG_START
* @type {string}
* @since 3.0.0
*
* @param {Phaser.Input.Pointer} pointer - The Pointer responsible for triggering this event.
* @param {Phaser.GameObjects.GameObject} gameObject - The interactive Game Object that this pointer is dragging.
*/
module.exports = 'dragstart';