engine.controls Functions
Handles input from the user (keyboard, mouse, joystick or gamepad). It can be used instead of the default engine.controls in one of the two possible ways:
- In case you need custom input handling (by AI, for example), you can implement your own controls via ControlsDummy.
-
You can get the current application controls (i.e. the instance of the default engine controls) via engine.getControls(). After that, you control user input using methods of Controls class exactly the same way as via engine.controls functions.
Such approach, for example, allows to switch between user-controlled input (Controls) and AI-controlled input (ControlsDummy) without having to change the game logic.
// Get the instance of default engine controls Controls controls = engine.getControls(); controls.setMouseDX(5);
Here, the function Controls::setMouseDX() does the same as engine.controls.setMouseDX().
The following set of functions is used to register actions (i.e. controls states) that will be executed on the provided input and bind them to specified input events. The actual meaning of all controls registered with CONTROLS_STATE_* variables (for example, CONTROLS_STATE_JUMP or CONTROLS_STATE_FIRE) is defined manually in script by the programmer who uses them. (See how to map controls states and keys).
See Also#
- The Creating a Car with Suspension Joints usage example demonstrating how to set control keys
Controls Class
Members
void engine.controls.setMouseDX ( float mousedx ) #
Updates a screen position change of the mouse pointer along the X axis.Arguments
- float mousedx - Change of the X-coordinate.
float engine.controls.getMouseDX ( ) #
Returns a screen position change of the mouse pointer along the X axis during the previous frame.Return value
Change of the X-coordinate.void engine.controls.setMouseDY ( float mousedy ) #
Updates a screen position change of the mouse pointer along the Y axis.Arguments
- float mousedy - Change of the Y-coordinate.
float engine.controls.getMouseDY ( ) #
Returns a screen position change of the mouse pointer along the Y axis during the previous frame.Return value
Change of the Y-coordinate.void engine.controls.setState ( int state, int value ) #
Toggles the state of the given control on or off.Arguments
- int state - State (one of CONTROLS_STATE_* variables).
- int value - Positive value to "press" the corresponding control; 0 to release it.
int engine.controls.getState ( int state ) #
Returns the state of a given control (pressed or unpressed).Arguments
- int state - State (one of CONTROLS_STATE_* variables).
Return value
1 if the control is pressed; otherwise, 0.int engine.controls.getType ( ) #
Returns the type of input controls.Return value
Controls type (one of CONTROLS_* variables):string engine.controls.getTypeName ( ) #
Returns a type name of input controls.Return value
Type name.int engine.controls.clearState ( int state ) #
Returns a control state and clears it to 0 (not pressed). This function allows to handle control only once even if it is kept pressed over several frames.Arguments
- int state - State (one of CONTROLS_STATE_* variables).
Return value
Returns the state of the given control: 1 if the control is pressed; otherwise,0.int engine.controls.saveState ( Stream stream ) #
Saves controls settings into the stream.Example using saveState() and restoreState() methods:
// Get the instance of default engine controls and set its state
Controls controls = engine.getControls();
controls.setMouseDX(5.0f);
// save state
Blob blob_state = new Blob();
controls.saveState(blob_state);
// change state
controls.setMouseDX(1.0f);
// restore state
blob_state.seekSet(0); // returning the carriage to the start of the blob
controls.restoreState(blob_state);
Arguments
- Stream stream - The stream to save controls data.
Return value
1 if the controls settings are saved successfully; otherwise, 0.int engine.controls.restoreState ( Stream stream ) #
Restores controls settings from the stream.Example using saveState() and restoreState() methods:
// Get the instance of default engine controls and set its state
Controls controls = engine.getControls();
controls.setMouseDX(5.0f);
// save state
Blob blob_state = new Blob();
controls.saveState(blob_state);
// change state
controls.setMouseDX(1.0f);
// restore state
blob_state.seekSet(0); // returning the carriage to the start of the blob
controls.restoreState(blob_state);
Arguments
- Stream stream - The stream to save controls data.