forked from phaserjs/phaser
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathDRAG_START_EVENT.js
More file actions
24 lines (23 loc) · 994 Bytes
/
Copy pathDRAG_START_EVENT.js
File metadata and controls
24 lines (23 loc) · 994 Bytes
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
/**
* @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 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
* @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';