Class: Keyboard

Members

callbackContext

Properties:

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

Source:

• input/Keyboard.js, line 36

disabled

You can disable all Keyboard Input by setting disabled to true. While true all new input related events will be ignored.

Properties:

Name	Type	Description
disabled	boolean	The disabled state of the Keyboard.

Default Value:

• false

Source:

• input/Keyboard.js, line 26

event

Properties:

Name	Type	Description
event	Object	The most recent DOM event. This is updated every time a new key is pressed or released.

Source:

• input/Keyboard.js, line 31

game

Properties:

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

Source:

• input/Keyboard.js, line 19

onDownCallback

Properties:

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

Source:

• input/Keyboard.js, line 41

onUpCallback

Properties:

Name	Type	Description
onUpCallback	function	This callback is invoked every time a key is released.

Source:

• input/Keyboard.js, line 46

Methods

addCallbacks(context, onDown, onUp)

Add callbacks to the Keyboard handler so that each time a key is pressed down or released the callbacks are activated.

Parameters:

Name	Type	Argument	Default	Description
context	Object			The context under which the callbacks are run.
onDown	function			This callback is invoked every time a key is pressed down.
onUp	function	<optional>	null	This callback is invoked every time a key is released.

Source:

• input/Keyboard.js, line 78

addKey(keycode) → {Phaser.Key}

If you need more fine-grained control over a Key you can create a new Phaser.Key object via this method. The Key object can then be polled, have events attached to it, etc.

Parameters:

Name	Type	Description
keycode	number	The keycode of the key, i.e. Phaser.Keyboard.UP or Phaser.Keyboard.SPACEBAR

Source:

• input/Keyboard.js, line 98

Returns:

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

Type

Phaser.Key

addKeyCapture(keycode)

By default when a key is pressed Phaser will not stop the event from propagating up to the browser. There are some keys this can be annoying for, like the arrow keys or space bar, which make the browser window scroll. You can use addKeyCapture to consume the keyboard event for specific keys so it doesn't bubble up to the the browser. Pass in either a single keycode or an array/hash of keycodes.

Parameters:

Name	Type	Description
keycode	Any	Either a single numeric keycode or an array/hash of keycodes: [65, 67, 68].

Source:

• input/Keyboard.js, line 194

clearCaptures()

Clear all set key captures.

Source:

• input/Keyboard.js, line 230

createCursorKeys() → {object}

Creates and returns an object containing 4 hotkeys for Up, Down, Left and Right.

Source:

• input/Keyboard.js, line 136

Returns:

An object containing properties: up, down, left and right. Which can be polled like any other Phaser.Key object.

Type

object

isDown(keycode) → {boolean}

Returns true of the key is currently pressed down. Note that it can only detect key presses on the web browser.

Parameters:

Name	Type	Description
keycode	number	The keycode of the key to remove, i.e. Phaser.Keyboard.UP or Phaser.Keyboard.SPACEBAR

Source:

• input/Keyboard.js, line 394

Returns:

True if the key is currently down.

Type

boolean

justPressed(keycode, duration) → {boolean}

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

Parameters:

Name	Type	Argument	Default	Description
keycode	number			The keycode of the key to remove, i.e. Phaser.Keyboard.UP or Phaser.Keyboard.SPACEBAR
duration	number	<optional>	250	The duration below which the key is considered as being just pressed.

Source:

• input/Keyboard.js, line 352

Returns:

True if the key is just pressed otherwise false.

Type

boolean

justReleased(keycode, duration) → {boolean}

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

Parameters:

Name	Type	Argument	Default	Description
keycode	number			The keycode of the key to remove, i.e. Phaser.Keyboard.UP or Phaser.Keyboard.SPACEBAR
duration	number	<optional>	250	The duration below which the key is considered as being just released.

Source:

• input/Keyboard.js, line 373

Returns:

True if the key is just released otherwise false.

Type

boolean

<protected> processKeyDown(event)

Process the keydown event.

Parameters:

Name	Type	Description
event	KeyboardEvent

Source:

• input/Keyboard.js, line 260

<protected> processKeyUp(event)

Process the keyup event.

Parameters:

Name	Type	Description
event	KeyboardEvent

Source:

• input/Keyboard.js, line 296

removeKey(keycode)

Removes a Key object from the Keyboard manager.

Parameters:

Name	Type	Description
keycode	number	The keycode of the key to remove, i.e. Phaser.Keyboard.UP or Phaser.Keyboard.SPACEBAR

Source:

• input/Keyboard.js, line 119

removeKeyCapture(keycode)

Removes an existing key capture.

Parameters:

Name	Type	Description
keycode	number

Source:

• input/Keyboard.js, line 218

reset()

Resets all Keys.

Source:

• input/Keyboard.js, line 331

start()

Starts the Keyboard event listeners running (keydown and keyup). They are attached to the document.body. This is called automatically by Phaser.Input and should not normally be invoked directly.

Source:

• input/Keyboard.js, line 153

stop()

Stops the Keyboard event listeners from running (keydown and keyup). They are removed from the document.body.

Source:

• input/Keyboard.js, line 182

update()

Updates all currently defined keys.

Source:

• input/Keyboard.js, line 241