Class: Gamepad

Phaser. Gamepad

new Gamepad(game)

The Gamepad class handles gamepad input and dispatches gamepad events.

Remember to call gamepad.start().

HTML5 GAMEPAD API SUPPORT IS AT AN EXPERIMENTAL STAGE! At moment of writing this (end of 2013) only Chrome supports parts of it out of the box. Firefox supports it via prefs flags (about:config, search gamepad). The browsers map the same controllers differently. This class has constants for Windows 7 Chrome mapping of XBOX 360 controller.

Parameters:
Name Type Description
game Phaser.Game

A reference to the currently running game.

Source:
src/input/Gamepad.js line 21

Members

<readonly> active : boolean

If the gamepad input is active or not - if not active it should not be updated from Input.js

Type:
  • boolean
Source:
src/input/Gamepad.js line 496

callbackContext : object

The context under which the callbacks are run.

Type:
  • object
Source:
src/input/Gamepad.js line 80

enabled : boolean

Gamepad input will only be processed if enabled.

Type:
  • boolean
Default Value:
  • true
Source:
src/input/Gamepad.js line 52

game : Phaser.Game

Local reference to game.

Type:
Source:
src/input/Gamepad.js line 26

onAxisCallback : function

This callback is invoked every time any gamepad axis is changed.

Type:
  • function
Source:
src/input/Gamepad.js line 105

onConnectCallback : function

This callback is invoked every time any gamepad is connected

Type:
  • function
Source:
src/input/Gamepad.js line 85

onDisconnectCallback : function

This callback is invoked every time any gamepad is disconnected

Type:
  • function
Source:
src/input/Gamepad.js line 90

onDownCallback : function

This callback is invoked every time any gamepad button is pressed down.

Type:
  • function
Source:
src/input/Gamepad.js line 95

onFloatCallback : function

This callback is invoked every time any gamepad button is changed to a value where value > 0 and value < 1.

Type:
  • function
Source:
src/input/Gamepad.js line 110

onUpCallback : function

This callback is invoked every time any gamepad button is released.

Type:
  • function
Source:
src/input/Gamepad.js line 100

<readonly> pad1 : Phaser.SinglePad

Gamepad #1

Type:
Source:
src/input/Gamepad.js line 538

<readonly> pad2 : Phaser.SinglePad

Gamepad #2

Type:
Source:
src/input/Gamepad.js line 552

<readonly> pad3 : Phaser.SinglePad

Gamepad #3

Type:
Source:
src/input/Gamepad.js line 566

<readonly> pad4 : Phaser.SinglePad

Gamepad #4

Type:
Source:
src/input/Gamepad.js line 580

<readonly> padsConnected : number

How many live gamepads are currently connected.

Type:
  • number
Source:
src/input/Gamepad.js line 524

<readonly> supported : boolean

Whether or not gamepads are supported in current browser.

Type:
  • boolean
Source:
src/input/Gamepad.js line 510

Methods

addCallbacks(context, callbacks)

Add callbacks to the main Gamepad handler 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 callback methods: onConnectCallback, onDisconnectCallback, onDownCallback, onUpCallback, onAxisCallback, onFloatCallback

Source:
src/input/Gamepad.js line 139

destroy()

Destroys this object and the associated event listeners.

Source:
src/input/Gamepad.js line 476

isDown(buttonCode)

Returns true if the button is currently pressed down, on ANY gamepad.

Parameters:
Name Type Description
buttonCode number

The buttonCode of the button to check for.

Source:
src/input/Gamepad.js line 457
Returns:

True if a button is currently down.

Type
boolean

justPressed(buttonCode [, duration])

Returns the "just pressed" state of a button from ANY gamepad connected. 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:
src/input/Gamepad.js line 415
Returns:

True if the button is just pressed otherwise false.

Type
boolean

justPressed(buttonCode [, duration])

Returns the "just released" state of a button from ANY gamepad connected. 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.

Source:
src/input/Gamepad.js line 436
Returns:

True if the button is just released otherwise false.

Type
boolean

reset()

Reset all buttons/axes of all gamepads

Source:
src/input/Gamepad.js line 400

setDeadZones()

Sets the deadZone variable for all four gamepads

Source:
src/input/Gamepad.js line 373

start()

Starts the Gamepad event handling. This MUST be called manually before Phaser will start polling the Gamepad API.

Source:
src/input/Gamepad.js line 162

stop()

Stops the Gamepad event handling.

Source:
src/input/Gamepad.js line 386

<protected> update()

Main gamepad update loop. Should not be called manually.

Source:
src/input/Gamepad.js line 231

phaser-ce@2.9.2 is on GitHub and NPM

Documentation generated by JSDoc 3.5.4 on 2017-11-09 using Tomorrow.