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.

Methods:

Name	Description View: Sort by:
setMouseDY	Setter and Getter for the screen position change of the mouse pointer along the y axis during the previous frame.
getMouseDY
setMouseDX	Setter and Getter for the screen position change of the mouse pointer along the x axis during the previous frame.
getMouseDX
getTypeName	Returns the current type name of input controls.
getType	Returns the current type 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).
getStateByName	Returns the state of a given control (pressed or unpressed) by the control state name.
getStateName	Returns the name of a given control state as a string.
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	ControlsApp instance.
CONTROLS_DUMMY = 1	ControlsDummy instance.
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.
CONTROLS_STATE_AUX_1 = 17	Auxiliary state (unreserved). It can be mapped to any control state.
CONTROLS_STATE_AUX_2 = 18	Auxiliary state (unreserved). It can be mapped to any control state.
CONTROLS_STATE_AUX_3 = 19	Auxiliary state (unreserved). It can be mapped to any control state.
CONTROLS_STATE_AUX_4 = 20	Auxiliary state (unreserved). It can be mapped to any control state.
CONTROLS_STATE_AUX_5 = 21	Auxiliary state (unreserved). It can be mapped to any control state.
CONTROLS_STATE_AUX_6 = 22	Auxiliary state (unreserved). It can be mapped to any control state.
CONTROLS_STATE_AUX_7 = 23	Auxiliary state (unreserved). It can be mapped to any control state.
CONTROLS_STATE_AUX_8 = 24	Auxiliary state (unreserved). It can be mapped to any control state.
CONTROLS_STATE_AUX_9 = 25	Auxiliary state (unreserved). It can be mapped to any control state.
CONTROLS_STATE_AUX_A = 26	Auxiliary state (unreserved). It can be mapped to any control state.
CONTROLS_STATE_AUX_B = 27	Auxiliary state (unreserved). It can be mapped to any control state.
CONTROLS_STATE_AUX_C = 28	Auxiliary state (unreserved). It can be mapped to any control state.
CONTROLS_STATE_AUX_D = 29	Auxiliary state (unreserved). It can be mapped to any control state.
CONTROLS_STATE_AUX_E = 30	Auxiliary state (unreserved). It can be mapped to any control state.
CONTROLS_STATE_AUX_F = 31	Auxiliary state (unreserved). It can be mapped to any control state.

Controls Class

Members

void setMouseDY ( float dy ) #

Sets a new screen position change of the mouse pointer along the y axis during the previous frame.

Arguments

float dy - The screen position change of the mouse pointer along the y axis during the previous frame.

float getMouseDY() const#

Returns the current screen position change of the mouse pointer along the y axis during the previous frame.

Return value

Current screen position change of the mouse pointer along the y axis during the previous frame.

void setMouseDX ( float dx ) #

Sets a new screen position change of the mouse pointer along the x axis during the previous frame.

Arguments

float dx - The screen position change of the mouse pointer along the x axis during the previous frame.

float getMouseDX() const#

Returns the current screen position change of the mouse pointer along the x axis during the previous frame.

Return value

Current screen position change of the mouse pointer along the x axis during the previous frame.

const char * getTypeName() const#

Returns the current type name of input controls.

Return value

Current type name of input controls.

getType() const#

Returns the current type of input controls.

Return value

Current Controls type (one of CONTROLS_* variables):

CONTROLS_APP = 0
CONTROLS_DUMMY

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.getStateByName ( string name ) #

Returns the state of a given control (pressed or unpressed) by the control state name.

Arguments

string name - State name (one of CONTROLS_STATE_* variables).

Return value

1 if the control is pressed; otherwise, 0.

string engine.controls.getStateName ( int state ) #

Returns the name of a given control state as a string.

Arguments

int state - State (one of CONTROLS_STATE_* variables).

Return value

Name of the control state.

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.

_{The information on this page is valid for UNIGINE 2.20 SDK.}

Last update: 2025-03-11

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

In This Article:

Methods:

Variables:

Controls Class

Members

void setMouseDY ( float dy ) #

Arguments

float getMouseDY() const#

Return value

void setMouseDX ( float dx ) #

Arguments

float getMouseDX() const#

Return value

const char * getTypeName() const#

Return value

getType() const#

Return value

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

Arguments

int engine.controls.getState ( int state ) #

Arguments

Return value

int engine.controls.getStateByName ( string name ) #

Arguments

Return value

string engine.controls.getStateName ( int state ) #

Arguments

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