userInputDisabled: Difference between revisions

From Bohemia Interactive Community
m (Text replacement - "\| *((\[\[[a-zA-Z0-9_ |()]+\]\],? ?)+) * \}\}" to "|seealso= $1 }}")
m (Move example to disableUserInput)
Tag: Manual revert
 
(16 intermediate revisions by the same user not shown)
Line 1: Line 1:
{{RV|type=command
{{RV|type=command


| arma3
|game1= arma3
|1.60
|version1= 1.60


|gr1= Interaction
|gr1= Interaction


| Returns true if user input is disabled
|descr= Returns whether or not user input is disabled.
| '''userInputDisabled'''
{{Feature|important|The disabled input system internally ''counts'' how many times <sqf inline>disableUserInput true</sqf> has been called - see {{Link|#Example 2}}.}}


| [[Boolean]]
|s1= [[userInputDisabled]]
 
 
|x1= Toggles user input<code>[[disableUserInput]] [[!_a|!]][[userInputDisabled]];</code>
|r1= [[Boolean]]
 
|x1= Toggles user input<sqf>disableUserInput !userInputDisabled;</sqf>
 
|x2= <sqf>
disableUserInput true;
disableUserInput true;
disableUserInput true;
 
diag_log str userInputDisabled; // true
 
disableUserInput false;
diag_log str userInputDisabled; // true
 
disableUserInput false;
diag_log str userInputDisabled; // true
 
disableUserInput false;
diag_log str userInputDisabled; // false - control is regained only here
</sqf>


|seealso= [[disableUserInput]]
|seealso= [[disableUserInput]]
}}
}}
{{GameCategory|arma3|Scripting Commands}}
[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]

Latest revision as of 16:32, 13 April 2025

Hover & click on the images for description

Description

Description:
Returns whether or not user input is disabled.
The disabled input system internally counts how many times disableUserInput true has been called - see Example 2.
Groups:
Interaction

Syntax

Syntax:
userInputDisabled
Return Value:
Boolean

Examples

Example 1:
Toggles user input
disableUserInput !userInputDisabled;
Example 2:
disableUserInput true; disableUserInput true; disableUserInput true; diag_log str userInputDisabled; // true disableUserInput false; diag_log str userInputDisabled; // true disableUserInput false; diag_log str userInputDisabled; // true disableUserInput false; diag_log str userInputDisabled; // false - control is regained only here

Additional Information

See also:
disableUserInput

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