API Docs for: 0.1.0
Show:

zerk.game.engine.system.control.keyboard Class

Extends zerk.observable
Defined in: src/zerk/class/game/engine/system/control/keyboard.js:1
Module: zerk

Keyboard Interface

Provides methods to handle keyboard inputs.

Methods

_onKeyDown

(
  • event
)
protected

Defined in src/zerk/class/game/engine/system/control/keyboard.js:252

Key down event handler

Parameters:

  • event DOMEvent

    DOM event

_onKeyPress

(
  • event
)
protected

Defined in src/zerk/class/game/engine/system/control/keyboard.js:302

Key press event handler

Parameters:

  • event DOMEvent

    DOM event

_onKeyUp

(
  • event
)
protected

Defined in src/zerk/class/game/engine/system/control/keyboard.js:277

Key up event handler

Parameters:

  • event DOMEvent

    DOM event

fireEvent

(
  • event
)
Boolen

Inherited from zerk.observable: src/zerk/class/observable.js:112

Fire event

Parameters:

  • event String

    Event name

Returns:

Boolen: Returns false when the bubble was canceled

init

(
  • engine
)

Inherited from zerk.observable but overwritten in src/zerk/class/game/engine/system/control/keyboard.js:185

Class constructor

Parameters:

on

(
  • event
  • callback
  • scope
)

Inherited from zerk.observable: src/zerk/class/observable.js:38

Register event handler

Parameters:

  • event String

    Event name

  • callback Function

    Callback function. Return false to cancel event bubble.

  • scope Object

    Scope to be used in callback function

un

(
  • event
  • callback
)
Boolen

Inherited from zerk.observable: src/zerk/class/observable.js:80

Unregister event handler

Parameters:

  • event String

    Event name

  • callback Function

    Callback function

Returns:

Boolen: Returns true on success

Properties

_control

zerk.game.engine.system.control

Defined in src/zerk/class/game/engine/system/control/keyboard.js:168

Back reference to control class

_eventListeners

Array protected

Inherited from zerk.observable: src/zerk/class/observable.js:18

List of event handlers

_keyMap

Object protected

Defined in src/zerk/class/game/engine/system/control/keyboard.js:176

Key map

pressedAlt

Boolean

Defined in src/zerk/class/game/engine/system/control/keyboard.js:64

State of the alt key

pressedArrowDown

Boolean

Defined in src/zerk/class/game/engine/system/control/keyboard.js:160

State of the arrow down key

pressedArrowLeft

Boolean

Defined in src/zerk/class/game/engine/system/control/keyboard.js:136

State of the arrow left key

pressedArrowRight

Boolean

Defined in src/zerk/class/game/engine/system/control/keyboard.js:152

State of the arrow right key

pressedArrowUp

Boolean

Defined in src/zerk/class/game/engine/system/control/keyboard.js:144

State of the arrow up key

pressedBackspace

Boolean

Defined in src/zerk/class/game/engine/system/control/keyboard.js:24

State of the backspace key

pressedCapsLock

Boolean

Defined in src/zerk/class/game/engine/system/control/keyboard.js:80

State of the capslock key

pressedCtrl

Boolean

Defined in src/zerk/class/game/engine/system/control/keyboard.js:56

State of the ctrl key

pressedEnd

Boolean

Defined in src/zerk/class/game/engine/system/control/keyboard.js:120

State of the end key

pressedEnter

Boolean

Defined in src/zerk/class/game/engine/system/control/keyboard.js:40

State of the enter key

pressedEscape

Boolean

Defined in src/zerk/class/game/engine/system/control/keyboard.js:88

State of the escape key

pressedHome

Boolean

Defined in src/zerk/class/game/engine/system/control/keyboard.js:128

State of the home key

pressedPageDown

Boolean

Defined in src/zerk/class/game/engine/system/control/keyboard.js:112

State of the pagedown key

pressedPageUp

Boolean

Defined in src/zerk/class/game/engine/system/control/keyboard.js:104

State of the pageup key

pressedPause

Boolean

Defined in src/zerk/class/game/engine/system/control/keyboard.js:72

State of the pause key

pressedShift

Boolean

Defined in src/zerk/class/game/engine/system/control/keyboard.js:48

State of the shift key

pressedSpace

Boolean

Defined in src/zerk/class/game/engine/system/control/keyboard.js:96

State of the space key

pressedTab

Boolean

Defined in src/zerk/class/game/engine/system/control/keyboard.js:32

State of the tab key

Events

keypress

Defined in src/zerk/class/game/engine/system/control/keyboard.js:267

Fires when a key is pressed

Event Payload:

  • event DOMEvent

keyup

Defined in src/zerk/class/game/engine/system/control/keyboard.js:292

Fires when a key is released

Event Payload:

  • event DOMEvent