User Input

Keyboard Events

TIP: You can listen to as many keys as you want using separate listeners, however each key can only have a single listener attached at a time.

Local vs Global Key Listeners

When listening on a key events you have the option of whether or not to register the listener at a local or global scope.

local scope: The listener only lasts as long as the program is running, useful for temporary things, e.g. navigating a menu screen.
global scope: The listener will live beyond the scope of the program that created it, useful for action keys, e.g. swinging a sword in combat.

The default scope for all listeners is local scope unless you tell the engine to register it at a global scope.

Listening for Key Down

// Register a listener on the "ENTER" key
rpgcode.registerKeyDown("ENTER", function(e) {
  // Enter was pressed down, do something interesting
}, false); // local scope = false, global scope = true

Listening for Key Up

// Register a listener on the "ENTER" key
rpgcode.registerKeyUp("ENTER", function(e) {
  // Enter was released up, do something interesting
}, false); // local scope = false, global scope = true

Telling if a Key is Held Down

Unfortunately in JavaScript there is no way to check the state of a key at a given time, instead we have to keep track of whether a key is currently held down. This can be done by simply toggling a boolean flag to true or false in the down and up listener for the key. For further details on the subject see this answer on stackoverflow.

// Store the state of the enter key
var enterDown = false;

// Register a listener on the "ENTER" key
rpgcode.registerKeyDown("ENTER", function(e) {
  // Enter was pressed down, do something interesting
  enterDown = true;
}, false); // local scope = false, global scope = true

// Register a listener on the "ENTER" key
rpgcode.registerKeyUp("ENTER", function(e) {
  // Enter was released up, do something interesting
  enterDown = false;
}, false); // local scope = false, global scope = true

How to Stop Listening to a Key

IMPORTANT: The engine will unregister local scope key listeners itself when the program that created them ends.

If you want to stop listening to a key event then you can unregister the listener on it at anytime, you need to do this separately for both down and up listeners.

// Stop listening to the "ENTER" button on down presses
rpgcode.unregisterKeyDown("ENTER", false);  // local scope = false, global scope = true

// Stop listening to the "ENTER" button on up releases
rpgcode.unregisterKeyUp("ENTER", false);  // local scope = false, global scope = true

Mouse Events

TIP: You can listen to as many mouse events as you want using separate listeners, however each mouse event can only have a single listener attached at a time.

When listening on a mouse events you have the option of whether or not to register the listener at a local or global scope.

local scope: The listener only lasts as long as the program is running, useful for temporary things, e.g. navigating a menu screen.
global scope: The listener will live beyond the scope of the program that created it, useful for action keys, e.g. swinging a sword in combat.

The default scope for all listeners is local scope unless you tell the engine to register it at a global scope.

Single Click

rpgcode.registerMouseClick(function(e) {
 // Log the x and y coordinates of the mouse.
 rpgcode.log(e.realX);
 rpgcode.log(e.realY);

 // Log the mouse button that has been clicked.
 rpgcode.log(e.mouseButton); // LEFT: 0, MIDDLE: 1, RIGHT: 2
}, false); // local scope = false, global scope = true

Double Click

rpgcode.registerMouseDoubleClick(function(e) {
 // Log the x and y coordinates of the mouse.
 rpgcode.log(e.realX);
 rpgcode.log(e.realY);

 // Log the mouse button that has been double clicked.
 rpgcode.log(e.mouseButton); // LEFT: 0, MIDDLE: 1, RIGHT: 2
}, false); // local scope = false, global scope = true

Mouse Button Down

rpgcode.registerMouseDown(function(e) {
 // Log the x and y coordinates of the mouse.
 rpgcode.log(e.realX);
 rpgcode.log(e.realY);

 // Log the mouse button that has been pressed down.
 rpgcode.log(e.mouseButton); // LEFT: 0, MIDDLE: 1, RIGHT: 2
}, false); // local scope = false, global scope = true

Mouse Button Up

rpgcode.registerMouseUp(function(e) {
 // Log the x and y coordinates of the mouse.
 rpgcode.log(e.realX);
 rpgcode.log(e.realY);

 // Log the mouse button that has been released.
 rpgcode.log(e.mouseButton); // LEFT: 0, MIDDLE: 1, RIGHT: 2
}, false); // local scope = false, global scope = true

Mouse Movement

rpgcode.registerMouseMove(function(e) {
 // Log the x and y coordinates of the mouse.
 rpgcode.log(e.realX);
 rpgcode.log(e.realY);
}, false); // local scope = false, global scope = true

How to Stop Listening to a Mouse Event

IMPORTANT: The engine will unregister local scope mouse listeners itself when the program that created them ends.