Phaser Class: SinglePad

new SinglePad(game, padParent)

A single Phaser Gamepad

Parameters:

Name	Type	Description
`game`	Phaser.Game	Current game instance.
`padParent`	Object	The parent Phaser.Gamepad object (all gamepads reside under this)

Source:

input/SinglePad.js, line 16

Members

callbackContext

Properties:

Name	Type	Description
`callbackContext`	Object	The context under which the callbacks are run.

Source:

input/SinglePad.js, line 38

<readonly> connected

Properties:

Name	Type	Description
`connected`	boolean	Whether or not this particular gamepad is connected or not.

Source:

input/SinglePad.js, line 33

deadZone

Properties:

Name	Type	Description
`deadZone`	number	Dead zone for axis feedback - within this value you won't trigger updates.

Source:

input/SinglePad.js, line 73

game

Properties:

Name	Type	Description
`game`	Phaser.Game	Local reference to game.

Source:

input/SinglePad.js, line 21

<readonly> index

Properties:

Name	Type	Description
`index`	number	The gamepad index as per browsers data

Source:

input/SinglePad.js, line 27

onAxisCallback

Properties:

Name	Type	Description
`onAxisCallback`	function	This callback is invoked every time an axis is changed.

Source:

input/SinglePad.js, line 63

onConnectCallback

Properties:

Name	Type	Description
`onConnectCallback`	function	This callback is invoked every time this gamepad is connected

Source:

input/SinglePad.js, line 43

onDisconnectCallback

Properties:

Name	Type	Description
`onDisconnectCallback`	function	This callback is invoked every time this gamepad is disconnected

Source:

input/SinglePad.js, line 48

onDownCallback

Properties:

Name	Type	Description
`onDownCallback`	function	This callback is invoked every time a button is pressed down.

Source:

input/SinglePad.js, line 53

onFloatCallback

Properties:

Name	Type	Description
`onFloatCallback`	function	This callback is invoked every time a button is changed to a value where value > 0 and value < 1.

Source:

input/SinglePad.js, line 68

onUpCallback

Properties:

Name	Type	Description
`onUpCallback`	function	This callback is invoked every time a gamepad button is released.

Source:

input/SinglePad.js, line 58

Methods

addCallbacks(context, callbacks)

Add callbacks to the this Gamepad to handle connect / disconnect / button down / button up / axis change / float value buttons.

Parameters:

Name	Type	Description
`context`	Object	The context under which the callbacks are run.
`callbacks`	Object	Object that takes six different callbak methods: onConnectCallback, onDisconnectCallback, onDownCallback, onUpCallback, onAxisCallback, onFloatCallback

Source:

input/SinglePad.js, line 121

axis(axisCode) → {number}

Returns value of requested axis.

Parameters:

Name	Type	Description
`axisCode`	number	The index of the axis to check

Source:

input/SinglePad.js, line 431

Returns:

Axis value if available otherwise false

Type: number

buttonValue(buttonCode) → {number}

Returns the value of a gamepad button. Intended mainly for cases when you have floating button values, for example analog trigger buttons on the XBOX 360 controller.

Parameters:

Name	Type	Description
`buttonCode`	number	The buttonCode of the button to check.

Source:

input/SinglePad.js, line 519

Returns:

Button value if available otherwise null. Be careful as this can incorrectly evaluate to 0.

Type: number

connect(rawPad)

Gamepad connect function, should be called by Phaser.Gamepad.

Parameters:

Name	Type	Description
`rawPad`	Object	The raw gamepad object

Source:

input/SinglePad.js, line 215

disconnect()

Gamepad disconnect function, should be called by Phaser.Gamepad.

Source:

input/SinglePad.js, line 259

getButton(buttonCode) → {Phaser.GamepadButton}

Gets a GamepadButton object from this controller to be stored and referenced locally. The GamepadButton object can then be polled, have events attached to it, etc.

Parameters:

Name	Type	Description
`buttonCode`	number	The buttonCode of the button, i.e. Phaser.Gamepad.BUTTON_0, Phaser.Gamepad.XBOX360_A, etc.

Source:

input/SinglePad.js, line 143

Returns:

The GamepadButton object which you can store locally and reference directly.

Type: Phaser.GamepadButton

isDown(buttonCode) → {boolean}

Returns true if the button is pressed down.

Parameters:

Name	Type	Description
`buttonCode`	number	The buttonCode of the button to check.

Source:

input/SinglePad.js, line 449

Returns:

True if the button is pressed down.

Type: boolean

isUp(buttonCode) → {boolean}

Returns true if the button is not currently pressed.

Parameters:

Name	Type	Description
`buttonCode`	number	The buttonCode of the button to check.

Source:

input/SinglePad.js, line 467

Returns:

True if the button is not currently pressed down.

Type: boolean

justPressed(buttonCode, duration) → {boolean}

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

Parameters:

Name	Type	Argument	Default	Description
`buttonCode`	number			The buttonCode of the button to check for.
`duration`	number	<optional>	250	The duration below which the button is considered as being just pressed.

Source:

input/SinglePad.js, line 502

Returns:

True if the button is just pressed otherwise false.

Type: boolean

justReleased(buttonCode, duration) → {boolean}

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

Parameters:

Name	Type	Argument	Default	Description
`buttonCode`	number			The buttonCode of the button to check for.
`duration`	number	<optional>	250	The duration below which the button is considered as being just released.