Phaser API Documentation

setDragState(pointer, state)


Sets the drag state of the given Pointer for this Input Plugin.

The state must be one of the following values:

0 = Not dragging anything 1 = Primary button down and objects below, so collect a draglist 2 = Pointer being checked if meets drag criteria 3 = Pointer meets criteria, notify the draglist 4 = Pointer actively dragging the draglist and has moved 5 = Pointer actively dragging but has been released, notify draglist


name type description
pointer Phaser.Input.Pointer

The Pointer to set the drag state for.

state number

The drag state value. An integer between 0 and 5.

Since: 3.16.0