Phaser API Documentation

  Version: 
getDragState(pointer)

Description:

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

The state will be one of the following:

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

Parameters:

name type description
pointer Phaser.Input.Pointer

The Pointer to get the drag state for.

Returns:
Description:

The drag state of the given Pointer.

Type:
  • number
Examples:
Since: 3.16.0