Filter
Contains information about a specific Gamepad Axis. Axis objects are created automatically by the Gamepad as they are needed.
Constructor:
new Axis(pad, index)
Parameters:
| name | type | description |
|---|---|---|
| pad | Phaser.Input.Gamepad.Gamepad |
A reference to the Gamepad that this Axis belongs to. |
| index | number |
The index of this Axis. |
Since: 3.0.0
Members
events: Phaser.Events.EventEmitter
Description:
An event emitter to use to emit the axis events.
Since: 3.0.0
index: number
Description:
The index of this Axis.
Type:
number
Since: 3.0.0
Description:
A reference to the Gamepad that this Axis belongs to.
Since: 3.0.0
threshold: number
Description:
Movement tolerance threshold below which axis values are ignored in getValue.
Type:
number
Default: 0.1
Since: 3.0.0
value: number
Description:
The raw axis value, between -1 and 1 with 0 being dead center.
Use the method getValue to get a normalized value with the threshold applied.
Type:
number
Default: 0
Since: 3.0.0
Methods
destroy()
Description:
Destroys this Axis instance and releases external references it holds.
Since: 3.10.0
getValue()
Description:
Applies the threshold value to the axis and returns it.
Returns:
Description:
The axis value, adjusted for the movement threshold.
Type:
- number
Since: 3.0.0
Possible examples