phaser/src/input/events/DROP_EVENT.js

24 lines
1,011 B
JavaScript
Raw Normal View History

2019-01-16 13:12:07 +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 Pointer Drop Input Event.
*
* This event is dispatched by the Input Plugin belonging to a Scene if a pointer drops a Game Object on a Drag Target.
*
* Listen to this event from within a Scene using: `this.input.on('drop', listener)`.
*
* To listen for this event from a _specific_ Game Object, use the [GAMEOBJECT_DROP]{@linkcode Phaser.Input.Events#event:GAMEOBJECT_DROP} event instead.
2019-01-16 13:12:07 +00:00
*
* @event Phaser.Input.Events#DROP
* @since 3.0.0
2019-01-16 13:12:07 +00:00
*
* @param {Phaser.Input.Pointer} pointer - The Pointer responsible for triggering this event.
* @param {Phaser.GameObjects.GameObject} gameObject - The interactive Game Object that this pointer was dragging.
* @param {Phaser.GameObjects.GameObject} target - The Drag Target the `gameObject` has been dropped on.
*/
module.exports = 'drop';