A Pointer object is used by the Mouse, Touch and MSPoint managers and represents a single finger on the touch screen.
| Name | Type | Default | Description |
|---|---|---|---|
game | Phaser.Game | A reference to the currently running game. | |
id | number | The ID of the Pointer object within the game. Each game can have up to 10 active pointers. | |
pointerMode | Phaser.PointerMode | (CURSOR | CONTACT) | The operational mode of this pointer, eg. CURSOR or TOUCH. |
The X1 button. This is typically the mouse Back button, but is often reconfigured.
On Linux (GTK) this is unsupported. On Windows if advanced pointer software (such as IntelliPoint) is installed this doesn't register.
The Eraser pen button on PointerEvent supported devices only.
The X2 button. This is typically the mouse Forward button, but is often reconfigured.
On Linux (GTK) this is unsupported. On Windows if advanced pointer software (such as IntelliPoint) is installed this doesn't register.
The Left Mouse button, or in PointerEvent devices a Touch contact or Pen contact.
The Middle Mouse button.
No buttons at all.
The Right Mouse button, or in PointerEvent devices a Pen contact with a barrel button.
An active pointer is one that is currently pressed down on the display. A Mouse is always active.
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.
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 propertiesleftButton, rightButton, middleButton and so on.
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).
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).
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).
A dirty pointer needs to re-poll any interactive objects it may have been over, regardless if it has moved or not.
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.
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.
A Pointer object that exists is allowed to be checked for physics collisions and overlaps.
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.
A reference to the currently running game.
The ID of the Pointer object within the game. Each game can have up to 10 active pointers.
The identifier property of the Pointer as set by the DOM event when this Pointer is started.
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.
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.
If the Pointer is a mouse or pen / stylus this is true, otherwise false.
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.
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.
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.
The horizontal processed relative movement of the Pointer in pixels since last event.
The vertical processed relative movement of the Pointer in pixels since last event.
The number of milliseconds since the last click or touch event.
The horizontal coordinate of the Pointer relative to whole document.
The vertical coordinate of the Pointer relative to whole document.
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.
The operational mode of this pointer.
A Phaser.Point object containing the current x/y values of the pointer on the display.
A Phaser.Point object containing the x/y values of the pointer when it was last in a down state on the display.
A Phaser.Point object containing the x/y values of the pointer when it was last released.
A timestamp representing when the Pointer was last tapped or clicked.
The horizontal raw relative movement of the Pointer in pixels since last event.
The vertical raw relative movement of the Pointer in pixels since last event.
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.
The horizontal coordinate of the Pointer relative to the screen.
The vertical coordinate of the Pointer relative to the screen.
The target property of the Pointer as set by the DOM event when this Pointer is started.
The Game Object this Pointer is currently over / touching / dragging.
A timestamp representing when the Pointer first touched the touchscreen.
A timestamp representing when the Pointer left the touchscreen.
The total number of times this Pointer has been touched to the touchscreen.
The const type of this object.
true if the Pointer is over the game canvas, otherwise false.
Gets the X value of this Pointer in world coordinates based on the world camera.
Gets the Y value of this Pointer in world coordinates based on the world camera.
The horizontal coordinate of the Pointer. This value is automatically scaled based on the game scale.
The vertical coordinate of the Pointer. This value is automatically scaled based on the game scale.
Add a click trampoline to this pointer.
A click trampoline is a callback that is run on the DOM 'click' event; this is primarily
needed with certain browsers (ie. IE11) which restrict some actions like requestFullscreen
to the DOM 'click' event and rejects it for 'pointer' and 'mouse' events.
This is used internally by the ScaleManager; click trampoline usage is uncommon.
Click trampolines can only be added to pointers that are currently down.
| Name | Type | Description |
|---|---|---|
name | string | The name of the trampoline; must be unique among active trampolines in this pointer. |
callback | function | Callback to run/trampoline. |
callbackContext | object | Context of the callback. |
callbackArgs | Array.<object> | null | Additional callback args, if any. Supplied as an array. |
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.
| Name | Type | Argument | Description |
|---|---|---|---|
duration | number | <optional> | The time to check against. If none given it will use InputManager.justPressedRate. |
true if the Pointer was pressed down within the duration given.
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.
| Name | Type | Argument | Description |
|---|---|---|---|
duration | number | <optional> | The time to check against. If none given it will use InputManager.justReleasedRate. |
true if the Pointer was released within the duration given.
Called when the Pointer leaves the target area.
| Name | Type | Description |
|---|---|---|
event | MouseEvent | PointerEvent | TouchEvent | The event passed up from the input handler. |
Called when the Pointer is moved.
| Name | Type | Argument | Default | Description |
|---|---|---|---|---|
event | MouseEvent | PointerEvent | TouchEvent | The event passed up from the input handler. | ||
fromClick | boolean | <optional> | false | Was this called from the click event? |
Process all interactive objects to find out which ones were updated in the recent Pointer move.
| Name | Type | Argument | Default | Description |
|---|---|---|---|---|
fromClick | boolean | <optional> | false | Was this called from the click event? |
True if this method processes an object (i.e. a Sprite becomes the Pointers currentTarget), otherwise false.
Resets the Pointer properties. Called by InputManager.reset when you perform a State change.
Resets the states of all the button booleans.
Resets the movementX and movementY properties. Use in your update handler after retrieving the values.
Called when the Pointer is pressed onto the touchscreen.
| Name | Type | Description |
|---|---|---|
event | any | The DOM event from the browser. |
Called when the Pointer leaves the touchscreen.
| Name | Type | Description |
|---|---|---|
event | MouseEvent | PointerEvent | TouchEvent | The event passed up from the input handler. |
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.
| Name | Type | Argument | Default | Description |
|---|---|---|---|---|
newTarget | Phaser.InputHandler | The new target for this Pointer. Note this is an | ||
silent | boolean | <optional> | false | If true the new target AND the old one will NOT dispatch their |
Called by the Input Manager.
Called when the event.buttons property changes from zero.
Contains a button bitmask.
| Name | Type | Description |
|---|---|---|
event | MouseEvent | The DOM event. |
© 2016 Richard Davey, Photon Storm Ltd.
Licensed under the MIT License.
http://phaser.io/docs/2.6.2/Phaser.Pointer.html