Keyboard input system for the whirlibulf game engine.
$ component install whirlibulf/keyboard-system
Register the system:
var Keyboard = require('keyboard-system');
game.use(new Keyboard({
stop: ['up', 'down', 'left', 'right']
}));
The system reads one property from the options object, stop.
This is a list of keys for which each event will not be propagated.
This is useful when you do not want the key to perform its regular browser function, such as moving with arrows keys or pressing tab.
This system automatically adds a keyboard component to the game engine.
The component is a map of key names to boolean pressed statuses.
WARNING: Do not write or modify the component object in any way. The component object is shared across all keyboard instances.
When adding the component to a game object, it does not take any options.
game.add('object id', 'keyboard');
var keyboard = game.get('object id', 'keyboard');
//if space bar is pressed, then keyboard['space'] === true
//if the letter 'a' is pressed, then keyboard['a'] === true
//if the number 6 is pressed, then keyboard['6'] === true
IMPORTANT: If a key is not pressed, then keyboard['key'] can be either false OR undefined.
If you want to check for shift + a (capital A), then you need to make sure both
keyboard['shift'] and keyboard['a'] are true.
List of special key names:
- backspace
- tab
- enter
- shift
- ctrl
- alt
- caps lock
- esc
- space
- page up
- page down
- end
- home
- left
- up
- right
- down
- insert
- delete
- windows
- num lock
- scroll lock
- ;
- =
- ,
-
- .
- /
- `
- [
- \
- ]
- '
- numpad [0-9]
- f[1-12]
MIT