engine.controls Functions

WarningThe scope of applications for UnigineScript is limited to implementing materials-related logic (material expressions, scriptable materials, brush materials). Do not use UnigineScript as a language for application logic, please consider C#/C++ instead, as these APIs are the preferred ones. Availability of new Engine features in UnigineScript (beyond its scope of applications) is not guaranteed, as the current level of support assumes only fixing critical issues.

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.
Source code (UnigineScript)
```
// 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).

Methods:

Name	Description View: Sort by:
setMouseDX	Updates a screen position change of the mouse pointer along the X axis.
getMouseDX	Returns a screen position change of the mouse pointer along the X axis during the previous frame.
setMouseDY	Updates a screen position change of the mouse pointer along the Y axis.
getMouseDY	Returns a screen position change of the mouse pointer along the Y axis during the previous frame.
getType	Returns the type of input controls.
getTypeName	Returns a type name of input controls.
setState	Toggles the state of the given control on or off.
getState	Returns the state of a given control (pressed or unpressed).
clearState	Returns a control state and clears it to 0 (not pressed).
saveState	Saves controls settings into the stream.
restoreState	Restores controls settings from the stream.

Variables:

Name	Description
CONTROLS_APP = 0	A ControlsApp instance.
CONTROLS_DUMMY = 1	ControlsDummy instance.
CONTROLS_JOYSTICK = 4	Joystick as the input device.
CONTROLS_SIXAXIS = 2	Sixaxis controller as the input device.
CONTROLS_XPAD360 = 3	XBox 360 game pad as the input device.
CONTROLS_NUM_STATES = 32	The total number of controls states.
CONTROLS_STATE_FORWARD = 0	A state in which the player moves forwards.
CONTROLS_STATE_BACKWARD = 1	A state in which the player moves backwards.
CONTROLS_STATE_MOVE_LEFT = 2	A state in which the player moves left.
CONTROLS_STATE_MOVE_RIGHT = 3	A state in which the player moves right.
CONTROLS_STATE_TURN_UP = 4	A state, in which the player turns upward.
CONTROLS_STATE_TURN_DOWN = 5	A state in which the player turns downward.
CONTROLS_STATE_TURN_LEFT = 6	A state in which the player turns left.
CONTROLS_STATE_TURN_RIGHT = 7	A state in which the player turns right.
CONTROLS_STATE_CROUCH = 8	A state in which the player crouches or squats.
CONTROLS_STATE_JUMP = 9	A state in which the player jumps.
CONTROLS_STATE_RUN = 10	A state in which the player runs.
CONTROLS_STATE_USE = 11	A state in which the player utilizes some object.
CONTROLS_STATE_FIRE = 12	A state in which the player fires their weapon.
CONTROLS_STATE_SAVE = 13	A state in which the world is being saved.
CONTROLS_STATE_RESTORE = 14	A state in which the world is being restored.
CONTROLS_STATE_SCREENSHOT = 15	A state in which a screenshot is being taken.
CONTROLS_STATE_AUX_0 = 16	Auxiliary state (unreserved) It can be mapped to any control state, if necessary (see the example).
CONTROLS_STATE_AUX_1 = 17	Auxiliary state (unreserved). It can be mapped to any control state, if necessary (see the example).
CONTROLS_STATE_AUX_2 = 18	Auxiliary state (unreserved). It can be mapped to any control state, if necessary (see the example).
CONTROLS_STATE_AUX_3 = 19	Auxiliary state (unreserved). It can be mapped to any control state, if necessary (see the example).
CONTROLS_STATE_AUX_4 = 20	Auxiliary state (unreserved). It can be mapped to any control state, if necessary (see the example).
CONTROLS_STATE_AUX_5 = 21	Auxiliary state (unreserved). It can be mapped to any control state, if necessary (see the example).
CONTROLS_STATE_AUX_6 = 22	Auxiliary state (unreserved). It can be mapped to any control state, if necessary (see the example).
CONTROLS_STATE_AUX_7 = 23	Auxiliary state (unreserved). It can be mapped to any control state, if necessary (see the example).
CONTROLS_STATE_AUX_8 = 24	Auxiliary state (unreserved). It can be mapped to any control state, if necessary (see the example).
CONTROLS_STATE_AUX_9 = 25	Auxiliary state (unreserved). It can be mapped to any control state, if necessary (see the example).
CONTROLS_STATE_AUX_A = 26	Auxiliary state (unreserved). It can be mapped to any control state, if necessary (see the example).
CONTROLS_STATE_AUX_B = 27	Auxiliary state (unreserved). It can be mapped to any control state, if necessary (see the example).
CONTROLS_STATE_AUX_C = 28	Auxiliary state (unreserved). It can be mapped to any control state, if necessary (see the example).
CONTROLS_STATE_AUX_D = 29	Auxiliary state (unreserved). It can be mapped to any control state, if necessary (see the example).
CONTROLS_STATE_AUX_E = 30	Auxiliary state (unreserved). It can be mapped to any control state, if necessary (see the example).
CONTROLS_STATE_AUX_F = 31	Auxiliary state (unreserved). It can be mapped to any control state, if necessary (see the example).

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:

Source code (UnigineScript)

// 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:

Source code (UnigineScript)

// 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 restored successfully; otherwise, 0.

Last update: 2021-12-13

Help improve this article

Was this article helpful?

Report a problem related to this article

(or select a word/phrase and press Ctrl+Enter)

engine.controls Functions

See Also#

Methods:

Variables:

Controls Class

Members

void engine.controls.setMouseDX ( float mousedx ) #

Arguments

float engine.controls.getMouseDX ( ) #

Return value

void engine.controls.setMouseDY ( float mousedy ) #

Arguments

float engine.controls.getMouseDY ( ) #

Return value

void engine.controls.setState ( int state, int value ) #

Arguments

int engine.controls.getState ( int state ) #

Arguments

Return value

int engine.controls.getType ( ) #

Return value

string engine.controls.getTypeName ( ) #

Return value

int engine.controls.clearState ( int state ) #

Arguments

Return value

int engine.controls.saveState ( Stream stream ) #

Arguments

Return value

int engine.controls.restoreState ( Stream stream ) #

Arguments

Return value