Phaser API Documentation

  Version: 
This is a beta release of our new docs system. Found an issue?
Please tell us about it in the #📖-newdocs-feedback channel on the Phaser Discord
Event: DRAG_LEAVE
Phaser.Input.Events.DRAG_LEAVE
DRAG_LEAVE

Description:

The Pointer Drag Leave Input Event.

This event is dispatched by the Input Plugin belonging to a Scene if a pointer drags a Game Object out of a Drag Target.

Listen to this event from within a Scene using: this.input.on('dragleave', 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_LEAVE event instead.

Parameters:

name type description
pointer Phaser.Input.Pointer

The Pointer responsible for triggering this event.

gameObject Phaser.GameObjects.GameObject

The interactive Game Object that this pointer is dragging.

target Phaser.GameObjects.GameObject

The drag target that this pointer has left.

Since: 3.0.0