A single Gamepad.
These are created, updated and managed by the Gamepad Plugin.
Constructor
new Gamepad(manager, pad)
Parameters
name | type | optional | description |
|---|---|---|---|
manager | No | A reference to the Gamepad Plugin. | |
pad | No | The Gamepad object, as extracted from GamepadEvent. |
Scope: static
Extends
Source: src/input/gamepad/Gamepad.js#L13
Since: 3.0.0
Public Members
A
A: boolean
Description:
Is the Gamepad's bottom button in the right button cluster being pressed? If the Gamepad doesn't have this button it will always return false. On a Dual Shock controller it's the X button. On an XBox controller it's the A button.
Source: src/input/gamepad/Gamepad.js#L609
Since: 3.10.0
axes
axes: Array.<Phaser.Input.Gamepad.Axis>
Description:
An array of Gamepad Axis objects, corresponding to the different axes available on the Gamepad, if any.
Source: src/input/gamepad/Gamepad.js#L105
Since: 3.0.0
B
B: boolean
Description:
Is the Gamepad's right button in the right button cluster being pressed? If the Gamepad doesn't have this button it will always return false. On a Dual Shock controller it's the Circle button. On an XBox controller it's the B button.
Source: src/input/gamepad/Gamepad.js#L666
Since: 3.10.0
buttons
buttons: Array.<Phaser.Input.Gamepad.Button>
Description:
An array of Gamepad Button objects, corresponding to the different buttons available on the Gamepad.
Source: src/input/gamepad/Gamepad.js#L89
Since: 3.0.0
connected
connected: boolean
Description:
Is this Gamepad currently connected or not?
Source: src/input/gamepad/Gamepad.js#L504
Since: 3.0.0
down
down: boolean
Description:
Is the Gamepad's Down button being pressed? If the Gamepad doesn't have this button it will always return false. This is the d-pad down button under standard Gamepad mapping.
Source: src/input/gamepad/Gamepad.js#L591
Since: 3.10.0
id
id: string
Description:
A string containing some information about the controller.
This is not strictly specified, but in Firefox it will contain three pieces of information separated by dashes (-): two 4-digit hexadecimal strings containing the USB vendor and product id of the controller, and the name of the controller as provided by the driver. In Chrome it will contain the name of the controller as provided by the driver, followed by vendor and product 4-digit hexadecimal strings.
Source: src/input/gamepad/Gamepad.js#L56
Since: 3.0.0
index
index: number
Description:
An integer that is unique for each Gamepad currently connected to the system. This can be used to distinguish multiple controllers. Note that disconnecting a device and then connecting a new device may reuse the previous index.
Source: src/input/gamepad/Gamepad.js#L71
Since: 3.0.0
L1
L1: number
Description:
Returns the value of the Gamepad's top left shoulder button. If the Gamepad doesn't have this button it will always return zero. The value is a float between 0 and 1, corresponding to how depressed the button is. On a Dual Shock controller it's the L1 button. On an XBox controller it's the LB button.
Source: src/input/gamepad/Gamepad.js#L685
Since: 3.10.0
L2
L2: number
Description:
Returns the value of the Gamepad's bottom left shoulder button. If the Gamepad doesn't have this button it will always return zero. The value is a float between 0 and 1, corresponding to how depressed the button is. On a Dual Shock controller it's the L2 button. On an XBox controller it's the LT button.
Source: src/input/gamepad/Gamepad.js#L705
Since: 3.10.0
left
left: boolean
Description:
Is the Gamepad's Left button being pressed? If the Gamepad doesn't have this button it will always return false. This is the d-pad left button under standard Gamepad mapping.
Source: src/input/gamepad/Gamepad.js#L537
Since: 3.10.0
leftStick
leftStick: Phaser.Math.Vector2
Description:
A Vector2 containing the most recent values from the Gamepad's left axis stick.
This is updated automatically as part of the Gamepad.update cycle.
The H Axis is mapped to the Vector2.x property, and the V Axis to the Vector2.y property.
The values are based on the Axis thresholds.
If the Gamepad does not have a left axis stick, the values will always be zero.
Source: src/input/gamepad/Gamepad.js#L291
Since: 3.10.0
manager
manager: Phaser.Input.Gamepad.GamepadPlugin
Description:
A reference to the Gamepad Plugin.
Source: src/input/gamepad/Gamepad.js#L38
Since: 3.0.0
pad
pad: any
Description:
A reference to the native Gamepad object that is connected to the browser.
Source: src/input/gamepad/Gamepad.js#L47
Since: 3.10.0
R1
R1: number
Description:
Returns the value of the Gamepad's top right shoulder button. If the Gamepad doesn't have this button it will always return zero. The value is a float between 0 and 1, corresponding to how depressed the button is. On a Dual Shock controller it's the R1 button. On an XBox controller it's the RB button.
Source: src/input/gamepad/Gamepad.js#L725
Since: 3.10.0
R2
R2: number
Description:
Returns the value of the Gamepad's bottom right shoulder button. If the Gamepad doesn't have this button it will always return zero. The value is a float between 0 and 1, corresponding to how depressed the button is. On a Dual Shock controller it's the R2 button. On an XBox controller it's the RT button.
Source: src/input/gamepad/Gamepad.js#L745
Since: 3.10.0
right
right: boolean
Description:
Is the Gamepad's Right button being pressed? If the Gamepad doesn't have this button it will always return false. This is the d-pad right button under standard Gamepad mapping.
Source: src/input/gamepad/Gamepad.js#L555
Since: 3.10.0
rightStick
rightStick: Phaser.Math.Vector2
Description:
A Vector2 containing the most recent values from the Gamepad's right axis stick.
This is updated automatically as part of the Gamepad.update cycle.
The H Axis is mapped to the Vector2.x property, and the V Axis to the Vector2.y property.
The values are based on the Axis thresholds.
If the Gamepad does not have a right axis stick, the values will always be zero.
Source: src/input/gamepad/Gamepad.js#L304
Since: 3.10.0
timestamp
timestamp: number
Description:
A timestamp containing the most recent time this Gamepad was updated.
Source: src/input/gamepad/Gamepad.js#L521
Since: 3.0.0
up
up: boolean
Description:
Is the Gamepad's Up button being pressed? If the Gamepad doesn't have this button it will always return false. This is the d-pad up button under standard Gamepad mapping.
Source: src/input/gamepad/Gamepad.js#L573
Since: 3.10.0
vibration
vibration: GamepadHapticActuator
Description:
The Gamepad's Haptic Actuator (Vibration / Rumble support). This is highly experimental and only set if both present on the device, and exposed by both the hardware and browser.
Source: src/input/gamepad/Gamepad.js#L114
Since: 3.10.0
X
X: boolean
Description:
Is the Gamepad's left button in the right button cluster being pressed? If the Gamepad doesn't have this button it will always return false. On a Dual Shock controller it's the Square button. On an XBox controller it's the X button.
Source: src/input/gamepad/Gamepad.js#L647
Since: 3.10.0
Y
Y: boolean
Description:
Is the Gamepad's top button in the right button cluster being pressed? If the Gamepad doesn't have this button it will always return false. On a Dual Shock controller it's the Triangle button. On an XBox controller it's the Y button.
Source: src/input/gamepad/Gamepad.js#L628
Since: 3.10.0
Private Members
_created
_created: number
Description:
When was this Gamepad created? Used to avoid duplicate event spamming in the update loop.
Access: private
Source: src/input/gamepad/Gamepad.js#L317
Since: 3.50.0
_FBLeftBottom
_FBLeftBottom: Phaser.Input.Gamepad.Button
Description:
A reference to the Bottom Left Front Button (L2 Shoulder Button)
Access: private
Source: src/input/gamepad/Gamepad.js#L219
Since: 3.10.0
_FBLeftTop
_FBLeftTop: Phaser.Input.Gamepad.Button
Description:
A reference to the Top Left Front Button (L1 Shoulder Button)
Access: private
Source: src/input/gamepad/Gamepad.js#L209
Since: 3.10.0
_FBRightBottom
_FBRightBottom: Phaser.Input.Gamepad.Button
Description:
A reference to the Bottom Right Front Button (R2 Shoulder Button)
Access: private
Source: src/input/gamepad/Gamepad.js#L239
Since: 3.10.0
_FBRightTop
_FBRightTop: Phaser.Input.Gamepad.Button
Description:
A reference to the Top Right Front Button (R1 Shoulder Button)
Access: private
Source: src/input/gamepad/Gamepad.js#L229
Since: 3.10.0
_HAxisLeft
_HAxisLeft: Phaser.Input.Gamepad.Button
Description:
A reference to the Horizontal Axis for the Left Stick.
Access: private
Source: src/input/gamepad/Gamepad.js#L251
Since: 3.10.0
_HAxisRight
_HAxisRight: Phaser.Input.Gamepad.Button
Description:
A reference to the Horizontal Axis for the Right Stick.
Access: private
Source: src/input/gamepad/Gamepad.js#L271
Since: 3.10.0
_LCBottom
_LCBottom: Phaser.Input.Gamepad.Button
Description:
A reference to the Bottom Button in the Left Cluster.
Access: private
Source: src/input/gamepad/Gamepad.js#L159
Since: 3.10.0
_LCLeft
_LCLeft: Phaser.Input.Gamepad.Button
Description:
A reference to the Left Button in the Left Cluster.
Access: private
Source: src/input/gamepad/Gamepad.js#L129
Since: 3.10.0
_LCRight
_LCRight: Phaser.Input.Gamepad.Button
Description:
A reference to the Right Button in the Left Cluster.
Access: private
Source: src/input/gamepad/Gamepad.js#L139
Since: 3.10.0
_LCTop
_LCTop: Phaser.Input.Gamepad.Button
Description:
A reference to the Top Button in the Left Cluster.
Access: private
Source: src/input/gamepad/Gamepad.js#L149
Since: 3.10.0
_RCBottom
_RCBottom: Phaser.Input.Gamepad.Button
Description:
A reference to the Bottom Button in the Right Cluster.
Access: private
Source: src/input/gamepad/Gamepad.js#L199
Since: 3.10.0
_RCLeft
_RCLeft: Phaser.Input.Gamepad.Button
Description:
A reference to the Left Button in the Right Cluster.
Access: private
Source: src/input/gamepad/Gamepad.js#L169
Since: 3.10.0
_RCRight
_RCRight: Phaser.Input.Gamepad.Button
Description:
A reference to the Right Button in the Right Cluster.
Access: private
Source: src/input/gamepad/Gamepad.js#L179
Since: 3.10.0
_RCTop
_RCTop: Phaser.Input.Gamepad.Button
Description:
A reference to the Top Button in the Right Cluster.
Access: private
Source: src/input/gamepad/Gamepad.js#L189
Since: 3.10.0
_VAxisLeft
_VAxisLeft: Phaser.Input.Gamepad.Button
Description:
A reference to the Vertical Axis for the Left Stick.
Access: private
Source: src/input/gamepad/Gamepad.js#L261
Since: 3.10.0
_VAxisRight
_VAxisRight: Phaser.Input.Gamepad.Button
Description:
A reference to the Vertical Axis for the Right Stick.
Access: private
Source: src/input/gamepad/Gamepad.js#L281
Since: 3.10.0
Public Methods
addListener
<instance> addListener(event, fn, [context])
Description:
Add a listener for a given event.
Parameters:
name | type | optional | default | description |
|---|---|---|---|---|
event | string | symbol | No | The event name. | |
fn | function | No | The listener function. | |
context | * | Yes | "this" | The context to invoke the listener with. |
Returns: Phaser.Input.Gamepad.Gamepad - this.
Inherits: Phaser.Events.EventEmitter#addListener
Source: src/events/EventEmitter.js#L111
Since: 3.0.0
destroy
<instance> destroy()
Description:
Destroys this Gamepad instance, its buttons and axes, and releases external references it holds.
Overrides: Phaser.Events.EventEmitter#destroy
Source: src/input/gamepad/Gamepad.js#L475
Since: 3.10.0
emit
<instance> emit(event, [args])
Description:
Calls each of the listeners registered for a given event.
Parameters:
name | type | optional | description |
|---|---|---|---|
event | string | symbol | No | The event name. |
args | * | Yes | Additional arguments that will be passed to the event handler. |
Returns: boolean - true if the event had listeners, else false.
Inherits: Phaser.Events.EventEmitter#emit
Source: src/events/EventEmitter.js#L86
Since: 3.0.0
eventNames
<instance> eventNames()
Description:
Return an array listing the events for which the emitter has registered listeners.
Returns: Array.<(string | symbol)> - undefined
Inherits: Phaser.Events.EventEmitter#eventNames
Source: src/events/EventEmitter.js#L55
Since: 3.0.0
getAxisTotal
<instance> getAxisTotal()
Description:
Gets the total number of axis this Gamepad claims to support.
Returns: number - The total number of axes this Gamepad claims to support.
Source: src/input/gamepad/Gamepad.js#L328
Since: 3.10.0
getAxisValue
<instance> getAxisValue(index)
Description:
Gets the value of an axis based on the given index. The index must be valid within the range of axes supported by this Gamepad. The return value will be a float between 0 and 1.
Parameters:
name | type | optional | description |
|---|---|---|---|
index | number | No | The index of the axes to get the value for. |
Returns: number - The value of the axis, between 0 and 1.
Source: src/input/gamepad/Gamepad.js#L341
Since: 3.10.0
getButtonTotal
<instance> getButtonTotal()
Description:
Gets the total number of buttons this Gamepad claims to have.
Returns: number - The total number of buttons this Gamepad claims to have.
Source: src/input/gamepad/Gamepad.js#L375
Since: 3.10.0
getButtonValue
<instance> getButtonValue(index)
Description:
Gets the value of a button based on the given index. The index must be valid within the range of buttons supported by this Gamepad.
The return value will be either 0 or 1 for an analogue button, or a float between 0 and 1 for a pressure-sensitive digital button, such as the shoulder buttons on a Dual Shock.
Parameters:
name | type | optional | description |
|---|---|---|---|
index | number | No | The index of the button to get the value for. |
Returns: number - The value of the button, between 0 and 1.
Source: src/input/gamepad/Gamepad.js#L388
Since: 3.10.0
isButtonDown
<instance> isButtonDown(index)
Description:
Returns if the button is pressed down or not. The index must be valid within the range of buttons supported by this Gamepad.
Parameters:
name | type | optional | description |
|---|---|---|---|
index | number | No | The index of the button to get the value for. |
Returns: boolean - true if the button is considered as being pressed down, otherwise false.
Source: src/input/gamepad/Gamepad.js#L407
Since: 3.10.0
listenerCount
<instance> listenerCount(event)
Description:
Return the number of listeners listening to a given event.
Parameters:
name | type | optional | description |
|---|---|---|---|
event | string | symbol | No | The event name. |
Returns: number - The number of listeners.
Inherits: Phaser.Events.EventEmitter#listenerCount
Source: src/events/EventEmitter.js#L75
Since: 3.0.0
listeners
<instance> listeners(event)
Description:
Return the listeners registered for a given event.
Parameters:
name | type | optional | description |
|---|---|---|---|
event | string | symbol | No | The event name. |
Returns: Array.<function()> - The registered listeners.
Inherits: Phaser.Events.EventEmitter#listeners
Source: src/events/EventEmitter.js#L64
Since: 3.0.0
off
<instance> off(event, [fn], [context], [once])
Description:
Remove the listeners of a given event.
Parameters:
name | type | optional | description |
|---|---|---|---|
event | string | symbol | No | The event name. |
fn | function | Yes | Only remove the listeners that match this function. |
context | * | Yes | Only remove the listeners that have this context. |
once | boolean | Yes | Only remove one-time listeners. |
Returns: Phaser.Input.Gamepad.Gamepad - this.
Inherits: Phaser.Events.EventEmitter#off
Source: src/events/EventEmitter.js#L151
Since: 3.0.0
on
<instance> on(event, fn, [context])
Description:
Add a listener for a given event.
Parameters:
name | type | optional | default | description |
|---|---|---|---|---|
event | string | symbol | No | The event name. | |
fn | function | No | The listener function. | |
context | * | Yes | "this" | The context to invoke the listener with. |
Returns: Phaser.Input.Gamepad.Gamepad - this.
Inherits: Phaser.Events.EventEmitter#on
Source: src/events/EventEmitter.js#L98
Since: 3.0.0
once
<instance> once(event, fn, [context])
Description:
Add a one-time listener for a given event.
Parameters:
name | type | optional | default | description |
|---|---|---|---|---|
event | string | symbol | No | The event name. | |
fn | function | No | The listener function. | |
context | * | Yes | "this" | The context to invoke the listener with. |
Returns: Phaser.Input.Gamepad.Gamepad - this.
Inherits: Phaser.Events.EventEmitter#once
Source: src/events/EventEmitter.js#L124
Since: 3.0.0
removeAllListeners
<instance> removeAllListeners([event])
Description:
Remove all listeners, or those of the specified event.
Parameters:
name | type | optional | description |
|---|---|---|---|
event | string | symbol | Yes | The event name. |
Returns: Phaser.Input.Gamepad.Gamepad - this.
Inherits: Phaser.Events.EventEmitter#removeAllListeners
Source: src/events/EventEmitter.js#L165
Since: 3.0.0
removeListener
<instance> removeListener(event, [fn], [context], [once])
Description:
Remove the listeners of a given event.
Parameters:
name | type | optional | description |
|---|---|---|---|
event | string | symbol | No | The event name. |
fn | function | Yes | Only remove the listeners that match this function. |
context | * | Yes | Only remove the listeners that have this context. |
once | boolean | Yes | Only remove one-time listeners. |
Returns: Phaser.Input.Gamepad.Gamepad - this.
Inherits: Phaser.Events.EventEmitter#removeListener
Source: src/events/EventEmitter.js#L137
Since: 3.0.0
setAxisThreshold
<instance> setAxisThreshold(value)
Description:
Sets the threshold value of all axis on this Gamepad. The value is a float between 0 and 1 and is the amount below which the axis is considered as not having been moved.
Parameters:
name | type | optional | description |
|---|---|---|---|
value | number | No | A value between 0 and 1. |
Source: src/input/gamepad/Gamepad.js#L358
Since: 3.10.0
shutdown
<instance> shutdown()
Description:
Removes all listeners.
Inherits: Phaser.Events.EventEmitter#shutdown
Source: src/events/EventEmitter.js#L31
Since: 3.0.0
Private Methods
update
<instance> update()
Description:
Internal update handler for this Gamepad. Called automatically by the Gamepad Manager as part of its update.
Access: private
Source: src/input/gamepad/Gamepad.js#L423
Since: 3.0.0