BIS fnc forceCuratorInterface: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (template:command argument fix)
m (Text replacement - ">\[ +(.*) *\] +(call|spawn)" to ">[$1] $2")
 
(29 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Function|= Comments
{{RV|type=function
____________________________________________________________________________________________


| arma 3 |= Game name
|game1= arma3
|version1= 1.16


|1.16|= Game version
|gr1= Curator
____________________________________________________________________________________________


| Force curator interface, so user cannot exit it by pressing Zeus key.|DESCRIPTION=
|descr= Force curator interface, so user cannot exit it by pressing Zeus key.
____________________________________________________________________________________________


| [mode, waitUntil] call [[BIS_fnc_forceCuratorInterface]] |SYNTAX=
|s1= [mode, waitUntil] call [[BIS_fnc_forceCuratorInterface]]
____________________________________________________________________________________________


|p1= mode: [[Boolean]] - [[True]] to force|PARAMETER1=
|p1= mode: [[Boolean]] - [[true]] to force
|p2= waitUntil: [[Boolean]] - (Optional, default [[false]]) - [[True]] to keep trying until the interface is actually opened|PARAMETER2=
|p2= waitUntil: [[Boolean]] - (Optional, default [[false]]) - [[true]] to keep trying until the interface is actually opened
____________________________________________________________________________________________


| [[Boolean]]|RETURNVALUE=
|r1= [[Boolean]]
____________________________________________________________________________________________


|x1= <code>[ [[True]], [[True]] ] [[call]] [[BIS_fnc_forceCuratorInterface]];</code> |=
|x1= <sqf>[true, true] call BIS_fnc_forceCuratorInterface;</sqf>
____________________________________________________________________________________________


| [[Curator]] |SEEALSO=
|seealso= [[Arma 3: Curator]]
}}
}}
<h3 style="display:none">Notes</h3>
<dl class="command_description">
<!-- Note Section BEGIN -->
<!-- Note Section END -->
</dl>
<h3 style="display:none">Bottom Section</h3>
[[Category:Function Group: Curator|{{uc:forceCuratorInterface}}]]
[[Category:Functions|{{uc:forceCuratorInterface}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:forceCuratorInterface}}]]

Latest revision as of 18:27, 8 November 2023

Hover & click on the images for description

Description

Description:
Force curator interface, so user cannot exit it by pressing Zeus key.
Execution:
call
Groups:
Curator

Syntax

Syntax:
[mode, waitUntil] call BIS_fnc_forceCuratorInterface
Parameters:
mode: Boolean - true to force
waitUntil: Boolean - (Optional, default false) - true to keep trying until the interface is actually opened
Return Value:
Boolean

Examples

Example 1:
[true, true] call BIS_fnc_forceCuratorInterface;

Additional Information

See also:
Arma 3: Curator

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