disableUserInput

1.001.001.001.001.501.000.50

LELocal

Hover & click on the images for description

Description

Description:

Disables or enables the keyboard and mouse input. Usually used during cutscenes.

⚠

Be careful and responsible with the usage of this command. Once the user input is disabled, the only option left is to restart the game. Make sure you provide scripted mechanics to resolve this, should you need to disable user input for any reason.

Groups:

Interaction

Syntax

Syntax:

disableUserInput state

Parameters:

state: Boolean - true to disable, false to enable

Return Value:

Nothing

Examples

Example 1:

disableUserInput true; // cutscene disableUserInput false;

Additional Information

See also:

userInputDisabled enableSimulation enableSimulationGlobal

Notes

Report bugs on the Feedback Tracker and/or discuss them on the Arma Discord or on the Forums.
Only post proven facts here! Add Note

Posted on 14 March 2014

Killzone_Kid

Sometimes, when disableUserInput true command is invoked while the user is holding a button, when disableUserInput false is called and the user is no longer holding the button, the input will resume as if the user is still holding the button. To reset this behaviour, disable and enable user input again in the same frame:

disableUserInput true; //do something disableUserInput false; disableUserInput true; disableUserInput false;

Unfortunately, if the user is moving mouse when disableUserInput true command is invoked, the mouse input will get stuck for the whole duration of disabled user input but will reset as soon as disableUserInput false is called. I was unable to find workaround for this one.

UPDATE: There is now userInputDisabled command, which allows one to check if user input is still disabled after enabling it, so that one can retry until enabling is successful.