Filter
Contains information about a specific button on a Gamepad. Button objects are created automatically by the Gamepad as they are needed.
Constructor:
new Button(pad, index)
Parameters:
| name | type | description |
|---|---|---|
| pad | Phaser.Input.Gamepad.Gamepad |
A reference to the Gamepad that this Button belongs to. |
| index | number |
The index of this Button. |
Since: 3.0.0
Members
events: Phaser.Events.EventEmitter
Description:
An event emitter to use to emit the button events.
Since: 3.0.0
index: number
Description:
The index of this Button.
Type:
number
Since: 3.0.0
Description:
A reference to the Gamepad that this Button belongs to.
Since: 3.0.0
pressed: boolean
Description:
Is the Button being pressed down or not?
Type:
boolean
Default: false
Since: 3.0.0
threshold: number
Description:
Can be set for analogue buttons to enable a 'pressure' threshold, before a button is considered as being 'pressed'.
Type:
number
Default: 1
Since: 3.0.0
value: number
Description:
Between 0 and 1.
Type:
number
Default: 0
Since: 3.0.0
Methods
destroy()
Description:
Destroys this Button instance and releases external references it holds.
Since: 3.10.0
Possible examples