Pointer

Instance Constructors

new Pointer(game: Phaser.Game, id: Double, pointerMode: Phaser.PointerMode)

game
A reference to the currently running game.
id
The ID of the Pointer object within the game. Each game can have up to 10 active pointers.
pointerMode
The operational mode of this pointer, eg. CURSOR or TOUCH.

Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
var active: Boolean

An active pointer is one that is currently pressed down on the display.
An active pointer is one that is currently pressed down on the display. A Mouse is always active.
final def asInstanceOf[T0]: T0

Definition Classes
Any
var backButton: Phaser.DeviceButton

If this Pointer is a Mouse or Pen / Stylus then you can access its X1 (back) button directly through this property.
If this Pointer is a Mouse or Pen / Stylus then you can access its X1 (back) button directly through this property.
The DeviceButton has its own properties such as isDown, duration and methods like justReleased for more fine-grained button control.
Please see the DeviceButton docs for details on browser button limitations.
var button: Any

The button property of the most recent DOM event when this Pointer is started.
The button property of the most recent DOM event when this Pointer is started. You should not rely on this value for accurate button detection, instead use the Pointer properties leftButton, rightButton, middleButton and so on.
var circle: Phaser.Circle

A Phaser.Circle that is centered on the x/y coordinates of this pointer, useful for hit detection.
A Phaser.Circle that is centered on the x/y coordinates of this pointer, useful for hit detection. The Circle size is 44px (Apples recommended "finger tip" size).
var clientX: Double

The horizontal coordinate of the Pointer within the application's client area at which the event occurred (as opposed to the coordinates within the page).
var clientY: Double

The vertical coordinate of the Pointer within the application's client area at which the event occurred (as opposed to the coordinates within the page).
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
var dirty: Boolean

A dirty pointer needs to re-poll any interactive objects it may have been over, regardless if it has moved or not
var duration: Double

How long the Pointer has been depressed on the touchscreen or any of the mouse buttons have been held down.
How long the Pointer has been depressed on the touchscreen or any of the mouse buttons have been held down. If not currently down it returns -1. If you need to test a specific mouse or pen button then access the buttons directly, i.e. Pointer.rightButton.duration.
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
var eraserButton: Phaser.DeviceButton

If this Pointer is a Pen / Stylus then you can access its eraser button directly through this property.
If this Pointer is a Pen / Stylus then you can access its eraser button directly through this property.
The DeviceButton has its own properties such as isDown, duration and methods like justReleased for more fine-grained button control.
Please see the DeviceButton docs for details on browser button limitations.
var exists: Boolean

A Pointer object that exists is allowed to be checked for physics collisions and overlaps.
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
var forwardButton: Phaser.DeviceButton

If this Pointer is a Mouse or Pen / Stylus then you can access its X2 (forward) button directly through this property.
If this Pointer is a Mouse or Pen / Stylus then you can access its X2 (forward) button directly through this property.
The DeviceButton has its own properties such as isDown, duration and methods like justReleased for more fine-grained button control.
Please see the DeviceButton docs for details on browser button limitations.
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def hasOwnProperty(v: String): Boolean

Definition Classes
Object
def hashCode(): Int

Definition Classes
AnyRef → Any
var interactiveCandidates: Array[_]

This array is erased and re-populated every time this Pointer is updated.
This array is erased and re-populated every time this Pointer is updated. It contains references to all of the Game Objects that were considered as being valid for processing by this Pointer, this frame. To be valid they must have suitable a priorityID, be Input enabled, visible and actually have the Pointer over them. You can check the contents of this array in events such as onInputDown, but beware it is reset every frame.
var isDown: Boolean

If the Pointer is touching the touchscreen, or any mouse or pen button is held down, isDown is set to true.
If the Pointer is touching the touchscreen, or any mouse or pen button is held down, isDown is set to true. If you need to check a specific mouse or pen button then use the button properties, i.e. Pointer.rightButton.isDown.
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
var isMouse: Boolean

If the Pointer is a mouse or pen / stylus this is true, otherwise false.
def isPrototypeOf(v: Object): Boolean

Definition Classes
Object
var isUp: Boolean

If the Pointer is not touching the touchscreen, or all mouse or pen buttons are up, isUp is set to true.
If the Pointer is not touching the touchscreen, or all mouse or pen buttons are up, isUp is set to true. If you need to check a specific mouse or pen button then use the button properties, i.e. Pointer.rightButton.isUp.
def justPressed(duration: Double = js.native): Boolean

The Pointer is considered justPressed if the time it was pressed onto the touchscreen or clicked is less than justPressedRate.
The Pointer is considered justPressed if the time it was pressed onto the touchscreen or clicked is less than justPressedRate. Note that calling justPressed doesn't reset the pressed status of the Pointer, it will return true for as long as the duration is valid.
If you wish to check if the Pointer was pressed down just once then see the Sprite.events.onInputDown event.
duration
The time to check against. If none given it will use InputManager.justPressedRate.
returns
true if the Pointer was pressed down within the duration given.
def justReleased(duration: Double = js.native): Boolean

The Pointer is considered justReleased if the time it left the touchscreen is less than justReleasedRate.
The Pointer is considered justReleased if the time it left the touchscreen is less than justReleasedRate. Note that calling justReleased doesn't reset the pressed status of the Pointer, it will return true for as long as the duration is valid.
If you wish to check if the Pointer was released just once then see the Sprite.events.onInputUp event.
duration
The time to check against. If none given it will use InputManager.justReleasedRate.
returns
true if the Pointer was released within the duration given.
def leave(event: Event): Unit

Called when the Pointer leaves the target area.
Called when the Pointer leaves the target area.
event
The event passed up from the input handler (MouseEvent | PointerEvent | TouchEvent).
var leftButton: Phaser.DeviceButton

If this Pointer is a Mouse or Pen / Stylus then you can access its left button directly through this property.
If this Pointer is a Mouse or Pen / Stylus then you can access its left button directly through this property.
The DeviceButton has its own properties such as isDown, duration and methods like justReleased for more fine-grained button control.
var middleButton: Phaser.DeviceButton

If this Pointer is a Mouse or Pen / Stylus then you can access its middle button directly through this property.
If this Pointer is a Mouse or Pen / Stylus then you can access its middle button directly through this property.
The DeviceButton has its own properties such as isDown, duration and methods like justReleased for more fine-grained button control.
Please see the DeviceButton docs for details on browser button limitations.
def move(event: Event, fromClick: Boolean = js.native): Unit

Called when the Pointer is moved.
Called when the Pointer is moved.
event
The event passed up from the input handler (MouseEvent | PointerEvent | TouchEvent).
fromClick
Was this called from the click event?
var movementX: Double

The horizontal processed relative movement of the Pointer in pixels since last event.
var movementY: Double

The vertical processed relative movement of the Pointer in pixels since last event.
var msSinceLastClick: Double

The number of milliseconds since the last click or touch event.
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
var pageX: Double

The horizontal coordinate of the Pointer relative to whole document.
var pageY: Double

The vertical coordinate of the Pointer relative to whole document.
var pointerId: Double

The pointerId property of the Pointer as set by the DOM event when this Pointer is started.
The pointerId property of the Pointer as set by the DOM event when this Pointer is started. The browser can and will recycle this value.
var position: Phaser.Point

A Phaser.Point object containing the current x/y values of the pointer on the display.
var positionDown: Phaser.Point

A Phaser.Point object containing the x/y values of the pointer when it was last in a down state on the display.
var positionUp: Phaser.Point

A Phaser.Point object containing the x/y values of the pointer when it was last released.
var previousTapTime: Double

A timestamp representing when the Pointer was last tapped or clicked.
def propertyIsEnumerable(v: String): Boolean

Definition Classes
Object
var rawMovementX: Double

The horizontal raw relative movement of the Pointer in pixels since last event.
var rawMovementY: Double

The vertical raw relative movement of the Pointer in pixels since last event.
def reset(): Unit

Resets the Pointer properties.
Resets the Pointer properties. Called by InputManager.reset when you perform a State change.
def resetMovement(): Unit

Resets the movementX and movementY properties.
Resets the movementX and movementY properties. Use in your update handler after retrieving the values.
var rightButton: Phaser.DeviceButton

If this Pointer is a Mouse or Pen / Stylus then you can access its right button directly through this property.
If this Pointer is a Mouse or Pen / Stylus then you can access its right button directly through this property.
The DeviceButton has its own properties such as isDown, duration and methods like justReleased for more fine-grained button control.
Please see the DeviceButton docs for details on browser button limitations.
var screenX: Double

The horizontal coordinate of the Pointer relative to the screen.
var screenY: Double

The vertical coordinate of the Pointer relative to the screen.
def start(event: Event): Unit

Called when the Pointer is pressed onto the touchscreen.
Called when the Pointer is pressed onto the touchscreen.
event
The DOM event from the browser.
def stop(event: Event): Unit

Called when the Pointer leaves the touchscreen.
Called when the Pointer leaves the touchscreen.
event
The event passed up from the input handler (MouseEvent | PointerEvent | TouchEvent).
def swapTarget(newTarget: Phaser.InputHandler, silent: Boolean = js.native): Unit

This will change the Pointer.targetObject object to be the one provided.
This will change the Pointer.targetObject object to be the one provided. This allows you to have fine-grained control over which object the Pointer is targeting. Note that even if you set a new Target here, it is still able to be replaced by any other valid target during the next Pointer update.
newTarget
The new target for this Pointer. Note this is an InputHandler, so don't pass a Sprite, instead pass sprite.input to it.
silent
If true the new target AND the old one will NOT dispatch their onInputOver or onInputOut events.
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
var target: Any

The target property of the Pointer as set by the DOM event when this Pointer is started.
var targetObject: Any

The Game Object this Pointer is currently over / touching / dragging.
var timeDown: Double

A timestamp representing when the Pointer first touched the touchscreen.
var timeUp: Double

A timestamp representing when the Pointer left the touchscreen.
def toLocaleString(): String

Definition Classes
Object
def toString(): String

Definition Classes
AnyRef → Any
var totalTouches: Int

The total number of times this Pointer has been touched to the touchscreen.
def type: Int

The const type of this object.
def update(): Unit

Called by the Input Manager.
def valueOf(): Any

Definition Classes
Object
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
var withinGame: Boolean

Returns true if the Pointer is over the game canvas, otherwise false.
def worldX: Double

Gets the X value of this Pointer in world coordinates based on the world camera.
def worldY: Double

Gets the Y value of this Pointer in world coordinates based on the world camera.
def x: Double

The horizontal coordinate of the Pointer.
The horizontal coordinate of the Pointer. This value is automatically scaled based on the game scale.
def y: Double

The vertical coordinate of the Pointer.
The vertical coordinate of the Pointer. This value is automatically scaled based on the game scale.

Related Docs: object Pointer | package phaser

class Pointer extends Object

Instance Constructors

new Pointer(game: Phaser.Game, id: Double, pointerMode: Phaser.PointerMode)

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

var active: Boolean

final def asInstanceOf[T0]: T0

var backButton: Phaser.DeviceButton

var button: Any

var circle: Phaser.Circle

var clientX: Double

var clientY: Double

def clone(): AnyRef

var dirty: Boolean

var duration: Double

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

var eraserButton: Phaser.DeviceButton

var exists: Boolean

def finalize(): Unit

var forwardButton: Phaser.DeviceButton

final def getClass(): Class[_]

def hasOwnProperty(v: String): Boolean

def hashCode(): Int

var interactiveCandidates: Array[_]

var isDown: Boolean

final def isInstanceOf[T0]: Boolean

var isMouse: Boolean

def isPrototypeOf(v: Object): Boolean

var isUp: Boolean

def justPressed(duration: Double = js.native): Boolean

def justReleased(duration: Double = js.native): Boolean

def leave(event: Event): Unit

var leftButton: Phaser.DeviceButton

var middleButton: Phaser.DeviceButton

def move(event: Event, fromClick: Boolean = js.native): Unit

var movementX: Double

var movementY: Double

var msSinceLastClick: Double

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

var pageX: Double

var pageY: Double

var pointerId: Double

var position: Phaser.Point

var positionDown: Phaser.Point

var positionUp: Phaser.Point

var previousTapTime: Double

def propertyIsEnumerable(v: String): Boolean

var rawMovementX: Double

var rawMovementY: Double

def reset(): Unit

def resetMovement(): Unit

var rightButton: Phaser.DeviceButton

var screenX: Double

var screenY: Double

def start(event: Event): Unit

def stop(event: Event): Unit

def swapTarget(newTarget: Phaser.InputHandler, silent: Boolean = js.native): Unit

final def synchronized[T0](arg0: ⇒ T0): T0

var target: Any

var targetObject: Any

var timeDown: Double

var timeUp: Double

def toLocaleString(): String

def toString(): String

var totalTouches: Int

def type: Int

def update(): Unit

def valueOf(): Any

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

var withinGame: Boolean

def worldX: Double