Members

buttonCode :number

The buttoncode of this button.

Source - input/GamepadButton.js, line 75

duration :number

If the button is down this value holds the duration of that button press and is constantly updated. If the button is up it holds the duration of the previous down session. The number of milliseconds this button has been held down for.

Default Value:

• 0

Source - input/GamepadButton.js, line 52

game :Phaser.Game

A reference to the currently running game.

Source - input/GamepadButton.js, line 26

isDown :boolean

The "down" state of the button.

Default Value:

• false

Source - input/GamepadButton.js, line 32

isUp :boolean

The "up" state of the button.

Default Value:

• true

Source - input/GamepadButton.js, line 38

onDown :Phaser.Signal

This Signal is dispatched every time this GamepadButton is pressed down. It is only dispatched once (until the button is released again).

Source - input/GamepadButton.js, line 80

onFloat :Phaser.Signal

This Signal is dispatched every time this GamepadButton changes floating value (between (but not exactly) 0 and 1)

Source - input/GamepadButton.js, line 90

onUp :Phaser.Signal

This Signal is dispatched every time this GamepadButton is pressed down. It is only dispatched once (until the button is released again).

Source - input/GamepadButton.js, line 85

pad :Phaser.SinglePad

A reference to the gamepad that owns this button.

Source - input/GamepadButton.js, line 21

repeats :number

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

Default Value:

• 0

Source - input/GamepadButton.js, line 64

timeDown :number

The timestamp when the button was last pressed down.

Default Value:

• 0

Source - input/GamepadButton.js, line 44

timeUp :number

The timestamp when the button was last released.

Default Value:

• 0

Source - input/GamepadButton.js, line 58

value :number

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

Default Value:

• 0

Source - input/GamepadButton.js, line 70

Methods

destroy()

Destroys this GamepadButton, this disposes of the onDown, onUp and onFloat signals and clears the pad and game references.

Source - input/GamepadButton.js, line 194

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 below which the button is considered as being just pressed.

Returns:

boolean -

True if the button is just pressed otherwise false.

Source - input/GamepadButton.js, line 149

justPressed(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 below which the button is considered as being just released.

Returns:

boolean -

True if the button is just pressed otherwise false.

Source - input/GamepadButton.js, line 164

<internal> processButtonDown(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 - input/GamepadButton.js, line 96

<internal> processButtonFloat(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 - input/GamepadButton.js, line 134

<internal> processButtonUp(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 - input/GamepadButton.js, line 116

reset()

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

Source - input/GamepadButton.js, line 179