Class: Phaser.DeviceButton

Constructor

new DeviceButton(parent, buttonCode)

Parameters

Name	Type	Description
parent	Phaser.Pointer | Phaser.SinglePad	A reference to the parent of this button. Either a Pointer or a Gamepad.
buttonCode	number	The button code this DeviceButton is responsible for.

Source code: input/DeviceButton.js (Line 31)

Public Properties

altKey : boolean

True if the alt key was held down when this button was last pressed or released.
Not supported on Gamepads.

Source code: input/DeviceButton.js (Line 87)

buttonCode : number

The buttoncode of this button if a Gamepad, or the DOM button event value if a Pointer.

Source code: input/DeviceButton.js (Line 114)

ctrlKey : boolean

True if the control key was held down when this button was last pressed or released.
Not supported on Gamepads.

Source code: input/DeviceButton.js (Line 103)

[readonly] duration : number

How long the button has been held down for in milliseconds.
If not currently down it returns -1.

Source code: input/DeviceButton.js (Line 300)

event : Object

The DOM event that caused the change in button state.

Source code: input/DeviceButton.js (Line 47)

game : Phaser.Game

A reference to the currently running game.

Source code: input/DeviceButton.js (Line 41)

isDown : boolean

The "down" state of the button.

Source code: input/DeviceButton.js (Line 53)

isUp : boolean

The "up" state of the button.

Default Value

• true

Source code: input/DeviceButton.js (Line 59)

onDown : Phaser.Signal

This Signal is dispatched every time this DeviceButton is pressed down.
It is only dispatched once (until the button is released again).
When dispatched it sends 2 arguments: A reference to this DeviceButton and the value of the button.

Source code: input/DeviceButton.js (Line 122)

onFloat : Phaser.Signal

Gamepad only.
This Signal is dispatched every time this DeviceButton changes floating value (between, but not exactly, 0 and 1).
When dispatched it sends 2 arguments: A reference to this DeviceButton and the value of the button.

Source code: input/DeviceButton.js (Line 138)

onUp : Phaser.Signal

This Signal is dispatched every time this DeviceButton is released from a down state.
It is only dispatched once (until the button is pressed again).
When dispatched it sends 2 arguments: A reference to this DeviceButton and the value of the button.

Source code: input/DeviceButton.js (Line 130)

parent : Phaser.Pointer | Phaser.SinglePad

A reference to the Pointer or Gamepad that owns this button.

Type

• Phaser.Pointer | Phaser.SinglePad

Source code: input/DeviceButton.js (Line 36)

repeats : number

Gamepad only.
If a button is held down this holds down the number of times the button has 'repeated'.

Source code: input/DeviceButton.js (Line 79)

shiftKey : boolean

True if the shift key was held down when this button was last pressed or released.
Not supported on Gamepads.

Source code: input/DeviceButton.js (Line 95)

timeDown : number

The timestamp when the button was last pressed down.

Source code: input/DeviceButton.js (Line 65)

timeUp : number

The timestamp when the button was last released.

Source code: input/DeviceButton.js (Line 71)

value : number

Button value. Mainly useful for checking analog buttons (like shoulder triggers) on Gamepads.

Source code: input/DeviceButton.js (Line 109)

Public Methods

destroy()

Destroys this DeviceButton, this disposes of the onDown, onUp and onFloat signals
and clears the parent and game references.

Source code: input/DeviceButton.js (Line 279)

justPressed(duration) → {boolean}

Returns the "just pressed" state of this button.
Just pressed is considered true if the button was pressed down within the duration given (default 250ms).

Parameters

Name	Type	Argument	Default	Description
duration	number	<optional>	250	The duration in ms below which the button is considered as being just pressed.

Returns

boolean -

True if the button is just pressed otherwise false.

Source code: input/DeviceButton.js (Line 228)

justReleased(duration) → {boolean}

Returns the "just released" state of this button.
Just released is considered as being true if the button was released within the duration given (default 250ms).

Parameters

Name	Type	Argument	Default	Description
duration	number	<optional>	250	The duration in ms below which the button is considered as being just released.

Returns

boolean -

True if the button is just released otherwise false.

Source code: input/DeviceButton.js (Line 244)

<internal> padFloat(value)

Called automatically by Phaser.SinglePad.

Parameters

Name	Type	Description
value	number	Button value

Internal:

• This member is internal (protected) and may be modified or removed in the future.

Source code: input/DeviceButton.js (Line 213)

reset()

Resets this DeviceButton, changing it to an isUp state and resetting the duration and repeats counters.

Source code: input/DeviceButton.js (Line 260)

<internal> start(event, value)

Called automatically by Phaser.Pointer and Phaser.SinglePad.
Handles the button down state.

Parameters

Name	Type	Argument	Description
event	object	<optional>	The DOM event that triggered the button change.
value	number	<optional>	The button value. Only get for Gamepads.

Internal:

• This member is internal (protected) and may be modified or removed in the future.

Source code: input/DeviceButton.js (Line 144)

<internal> stop(event, value)

Called automatically by Phaser.Pointer and Phaser.SinglePad.
Handles the button up state.

Parameters

Name	Type	Argument	Description
event	object	<optional>	The DOM event that triggered the button change.
value	number	<optional>	The button value. Only get for Gamepads.

Internal:

• This member is internal (protected) and may be modified or removed in the future.

Source code: input/DeviceButton.js (Line 179)