disableUserInput: Difference between revisions

Latest revision as of 16:35, 13 April 2025

1.00

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;
Example 2:: Reset user input if a key was pressed:
disableUserInput true; // here e.g W was pressed sleep 2; // the user releases keys disableUserInput false; // the game considers W is still pressed as it did not listen to a "KeyUp" event disableUserInput true; disableUserInput false; // this resets released keys making the issue invisible // this workaround does not fix the mouse input that may get stuck on disableUserInput call

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

@@ Line 1: / Line 1: @@
-{{Command|= Comments
+{{RV|type=command
-____________________________________________________________________________________________
-| ofp |= Game name
+|game1= ofp
+|version1= 1.00
-|1.00|= Game version
+|game2= ofpe
+|version2= 1.00
-|eff= local |= Effects in MP
+|game3= arma1
-____________________________________________________________________________________________
+|version3= 1.00
-| Disable and enable the keyboard and mouse input, usually used during cutscenes.
+|game4= arma2
+|version4= 1.00
-Be careful with the usage of this command, always remember to enable the user input again, as once the user input is disabled, you can only shut down OFP but not exit the mission with escape.
+|game5= arma2oa
-Additionally, if NOT used locally by a Server (meaning only for the Person it should be executed on), everybody in range of the trigger/other way of activation will be affected. Same with the Editor, making a simple trigger and adding the command in question, is not recommended, since the command doesn't accept detailed information WHICH object to affect, and the command clearly says "disableUSERinput". |= Description
+|version5= 1.50
-____________________________________________________________________________________________
-| '''disableUserInput''' state |= Syntax
+|game6= tkoh
+|version6= 1.00
-|p1= state: [[Boolean]] |= Parameter 1
+|game7= arma3
+|version7= 0.50
-| [[Nothing]] |= Return value
+|gr1= Interaction
-____________________________________________________________________________________________
-|x1= <pre>disableUserInput true
-; cutscene
-disableUserInput false</pre> |= Example 1
+|eff= local
-____________________________________________________________________________________________
-|  |= See also
+|descr= Disables or enables the keyboard and mouse input. Usually used during cutscenes.{{Feature|warning|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.}}
-}}
+|s1= [[disableUserInput]] state
+|p1= state: [[Boolean]] - [[true]] to disable, [[false]] to enable
+|r1= [[Nothing]]
+|x1= <sqf>
+disableUserInput true;
+// cutscene
+disableUserInput false;
+</sqf>
+|x2= Reset user input if a key was pressed:
+<sqf>
+disableUserInput true;	// here e.g W was pressed
+sleep 2;				// the user releases keys
+disableUserInput false;	// the game considers W is still pressed as it did not listen to a "KeyUp" event
-<h3 style="display:none">Notes</h3>
+disableUserInput true;
-<dl class="command_description">
+disableUserInput false;	// this resets released keys making the issue invisible
-<!-- Note Section BEGIN -->
-<!-- Note Section END -->
-</dl>
-<h3 style="display:none">Bottom Section</h3>
+// this workaround does not fix the mouse input that may get stuck on [[disableUserInput]] call
+</sqf>
-[[Category:Scripting Commands|DISABLEUSERINPUT]]
+|seealso= [[userInputDisabled]] [[enableSimulation]] [[enableSimulationGlobal]]
-[[Category:Scripting Commands OFP 1.96|DISABLEUSERINPUT]]
+}}
-[[Category:Scripting Commands OFP 1.46|DISABLEUSERINPUT]]
-[[Category:Scripting Commands ArmA|DISABLEUSERINPUT]]
-[[Category:Command_Group:_GUI_Control|{{uc:{{PAGENAME}}}}]]
-[[Category:Command_Group:_Interaction|{{uc:{{PAGENAME}}}}]]
-[[Category:Scripting Commands ArmA2|{{uc:{{PAGENAME}}}}]]
-[[Category:Scripting_Commands_Take_On_Helicopters|{{uc:{{PAGENAME}}}}]]