userInputDisabled: Difference between revisions

From Bohemia Interactive Community
m (Text replacement - "|= Comments" to "|Comments=")
m (Move example to disableUserInput)
Tag: Manual revert
 
(26 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{Command|Comments=
{{RV|type=command
____________________________________________________________________________________________


| arma3 |= Game name
|game1= arma3
|1.60|= Game version
|version1= 1.60
____________________________________________________________________________________________


| Returns true if user input is disabled |DESCRIPTION=
|gr1= Interaction
____________________________________________________________________________________________
| '''userInputDisabled'''|SYNTAX=


| [[Boolean]]|RETURNVALUE=
|descr= Returns whether or not user input is disabled.
____________________________________________________________________________________________
{{Feature|important|The disabled input system internally ''counts'' how many times <sqf inline>disableUserInput true</sqf> has been called - see {{Link|#Example 2}}.}}
 
|x1= <code>[[if]] (![[userInputDisabled]]) [[then]]
{
  [[disableUserInput]] [[true]];
}
[[else]]
{
  [[disableUserInput]] [[false]];
};</code> |EXAMPLE1=
____________________________________________________________________________________________


| [[disableUserInput]] |SEEALSO=
|s1= [[userInputDisabled]]


}}
|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>


[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
|seealso= [[disableUserInput]]
[[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