new Keyboard(game)
The Keyboard class handles looking after keyboard input for your game. It will recognise and respond to key presses and dispatch the required events.
Parameters:
| Name | Type | Description |
|---|---|---|
game |
Phaser.Game | A reference to the currently running game. |
- Source:
Members
-
callbackContext
-
- Source:
Properties:
Name Type Description callbackContextObject The context under which the callbacks are run.
-
disabled
-
You can disable all Keyboard Input by setting disabled to true. While true all new input related events will be ignored.
- Default Value:
- false
- Source:
Properties:
Name Type Description disabledboolean The disabled state of the Keyboard.
-
event
-
- Source:
Properties:
Name Type Description eventObject The most recent DOM event. This is updated every time a new key is pressed or released.
-
game
-
- Source:
Properties:
Name Type Description gamePhaser.Game Local reference to game.
-
onDownCallback
-
- Source:
Properties:
Name Type Description onDownCallbackfunction This callback is invoked every time a key is pressed down.
-
onUpCallback
-
- Source:
Properties:
Name Type Description onUpCallbackfunction This callback is invoked every time a key is released.
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 contextObject The context under which the callbacks are run.
onDownfunction This callback is invoked every time a key is pressed down.
onUpfunction <optional>
null This callback is invoked every time a key is released.
- Source:
-
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 keycodenumber The keycode of the key, i.e. Phaser.Keyboard.UP or Phaser.Keyboard.SPACEBAR
- Source:
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 keycodeAny Either a single numeric keycode or an array/hash of keycodes: [65, 67, 68].
- Source:
-
clearCaptures()
-
Clear all set key captures.
- Source:
-
createCursorKeys() → {object}
-
Creates and returns an object containing 4 hotkeys for Up, Down, Left and Right.
- Source:
Returns:
An object containing properties: up, down, left and right. Which can be polled like any other Phaser.Key object.
- Type
- object
-
destroy()
-
Stops the Keyboard event listeners from running (keydown and keyup). They are removed from the window. Also clears all key captures and currently created Key objects.
- Source:
-
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 keycodenumber The keycode of the key to remove, i.e. Phaser.Keyboard.UP or Phaser.Keyboard.SPACEBAR
- Source:
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 keycodenumber The keycode of the key to remove, i.e. Phaser.Keyboard.UP or Phaser.Keyboard.SPACEBAR
durationnumber <optional>
250 The duration below which the key is considered as being just pressed.
- Source:
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 keycodenumber The keycode of the key to remove, i.e. Phaser.Keyboard.UP or Phaser.Keyboard.SPACEBAR
durationnumber <optional>
250 The duration below which the key is considered as being just released.
- Source:
Returns:
True if the key is just released otherwise false.
- Type
- boolean
-
<protected> processKeyDown(event)
-
Process the keydown event.
Parameters:
Name Type Description eventKeyboardEvent - Source:
-
<protected> processKeyUp(event)
-
Process the keyup event.
Parameters:
Name Type Description eventKeyboardEvent - Source:
-
removeKey(keycode)
-
Removes a Key object from the Keyboard manager.
Parameters:
Name Type Description keycodenumber The keycode of the key to remove, i.e. Phaser.Keyboard.UP or Phaser.Keyboard.SPACEBAR
- Source:
-
removeKeyCapture(keycode)
-
Removes an existing key capture.
Parameters:
Name Type Description keycodenumber - Source:
-
reset(hard)
-
Resets all Keys.
Parameters:
Name Type Argument Default Description hardboolean <optional>
true A soft reset won't reset any events or callbacks that are bound to the Keys. A hard reset will.
- Source:
-
start()
-
Starts the Keyboard event listeners running (keydown and keyup). They are attached to the window. This is called automatically by Phaser.Input and should not normally be invoked directly.
- Source:
-
stop()
-
Stops the Keyboard event listeners from running (keydown and keyup). They are removed from the window.
- Source:
-
update()
-
Updates all currently defined keys.
- Source: