Class: GamepadButton

Phaser. GamepadButton

If you need more fine-grained control over the handling of specific buttons you can create and use Phaser.GamepadButton objects.

new GamepadButton(pad, buttonCode)

Parameters:
Name Type Description
pad Phaser.SinglePad

A reference to the gamepad that owns this button.

buttonCode number

The button code this GamepadButton is responsible for.

Source:

Members

buttonCode

Properties:
Name Type Description
buttonCode number

The buttoncode of this button.

Source:

duration

If the button is down this value holds the duration of that button press and is constantly updated. If the button is up it holds the duration of the previous down session.

Properties:
Name Type Description
duration number

The number of milliseconds this button has been held down for.

Default Value:
  • 0
Source:

game

Properties:
Name Type Description
game Phaser.Game

A reference to the currently running game.

Source:

isDown

Properties:
Name Type Description
isDown boolean

The "down" state of the button.

Default Value:
  • false
Source:

isUp

Properties:
Name Type Description
isUp boolean

The "up" state of the button.

Default Value:
  • true
Source:

onDown

Properties:
Name Type Description
onDown Phaser.Signal

This Signal is dispatched every time this GamepadButton is pressed down. It is only dispatched once (until the button is released again).

Source:

onFloat

Properties:
Name Type Description
onFloat Phaser.Signal

This Signal is dispatched every time this GamepadButton changes floating value (between (but not exactly) 0 and 1)

Source:

onUp

Properties:
Name Type Description
onUp Phaser.Signal

This Signal is dispatched every time this GamepadButton is pressed down. It is only dispatched once (until the button is released again).

Source:

pad

Properties:
Name Type Description
pad Phaser.SinglePad

A reference to the gamepad that owns this button.

Source:

repeats

Properties:
Name Type Description
repeats number

If a button is held down this holds down the number of times the button has 'repeated'.

Default Value:
  • 0
Source:

timeDown

Properties:
Name Type Description
timeDown number

The timestamp when the button was last pressed down.

Default Value:
  • 0
Source:

timeUp

Properties:
Name Type Description
timeUp number

The timestamp when the button was last released.

Default Value:
  • 0
Source:

value

Properties:
Name Type Description
value number

Button value. Mainly useful for checking analog buttons (like shoulder triggers)

Default Value:
  • 0
Source:

Methods

destroy()

Destroys this GamepadButton, this disposes of the onDown, onUp and onFloat signals and clears the pad and game references.

Source:

justPressed(duration) → {boolean}

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

Parameters:
Name Type Argument Default Description
duration number <optional>
250

The duration below which the button is considered as being just pressed.

Source:
Returns:

True if the button is just pressed otherwise false.

Type
boolean

justPressed(duration) → {boolean}

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

Parameters:
Name Type Argument Default Description
duration number <optional>
250

The duration below which the button is considered as being just released.

Source:
Returns:

True if the button is just pressed otherwise false.

Type
boolean

<protected> processButtonDown(value)

Called automatically by Phaser.SinglePad.

Parameters:
Name Type Description
value number

Button value

Source:

<protected> processButtonFloat(value)

Called automatically by Phaser.SinglePad.

Parameters:
Name Type Description
value number

Button value

Source:

<protected> processButtonUp(value)

Called automatically by Phaser.SinglePad.

Parameters:
Name Type Description
value number

Button value

Source:

reset()

Resets this GamepadButton, changing it to an isUp state and resetting the duration and repeats counters.

Source:
Phaser Copyright © 2012-2014 Photon Storm Ltd.
Documentation generated by JSDoc 3.3.0-dev on Thu Jul 10 2014 20:19:03 GMT+0100 (BST) using the DocStrap template.