phaser/src/input/events/DRAG_ENTER_EVENT.js

27 lines
1.1 KiB
JavaScript
Raw Normal View History

2019-01-16 13:12:07 +00:00
/**
* @author Richard Davey <rich@photonstorm.com>
2023-01-02 17:36:27 +00:00
* @copyright 2013-2023 Photon Storm Ltd.
2019-05-10 15:15:04 +00:00
* @license {@link https://opensource.org/licenses/MIT|MIT License}
2019-01-16 13:12:07 +00:00
*/
/**
* The Pointer Drag Enter Input Event.
2022-02-28 14:29:51 +00:00
*
2019-01-16 13:12:07 +00:00
* This event is dispatched by the Input Plugin belonging to a Scene if a pointer drags a Game Object into a Drag Target.
2022-02-28 14:29:51 +00:00
*
2019-01-16 13:12:07 +00:00
* Listen to this event from within a Scene using: `this.input.on('dragenter', listener)`.
2022-02-28 14:29:51 +00:00
*
2019-01-16 13:12:07 +00:00
* A Pointer can only drag a single Game Object at once.
2022-02-28 14:29:51 +00:00
*
* To listen for this event from a _specific_ Game Object, use the [GAMEOBJECT_DRAG_ENTER]{@linkcode Phaser.Input.Events#event:GAMEOBJECT_DRAG_ENTER} event instead.
2019-01-16 13:12:07 +00:00
*
* @event Phaser.Input.Events#DRAG_ENTER
* @type {string}
* @since 3.0.0
2022-02-28 14:29:51 +00:00
*
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 is dragging.
* @param {Phaser.GameObjects.GameObject} target - The drag target that this pointer has moved into.
*/
module.exports = 'dragenter';