BIS fnc blackOut: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (template:command argument fix)
m (Text replacement - " |s1=[" to " |s1= [")
 
(22 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Function|= Comments
{{RV|type=function
____________________________________________________________________________________________


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


|1.00|= Game version
|gr1= GUI
____________________________________________________________________________________________


| Register a black screen. Start the black screen when the first request is registered. |DESCRIPTION=
|descr= Register a black screen. Start the black screen when the first request is registered.
____________________________________________________________________________________________


| [id,smoothing] call [[BIS_fnc_blackOut]] |SYNTAX=
|s1= [id, smoothing, fadeSpeed] call [[BIS_fnc_blackOut]]
____________________________________________________________________________________________


|p1= id: [[String]] - Black screen id used for registration (case sensitive)|PARAMETER1=
|p1= id: [[String]] - black screen id used for registration (case sensitive)
|p2= smoothing: [[Boolean]] - (Optional, default [[true]] Smoothing|PARAMETER2=
____________________________________________________________________________________________


| [[Nothing]]|RETURNVALUE=
|p2= smoothing: [[Boolean]] - (Optional, default [[true]]) smooth transition - [[false]] for an immediate blackout
____________________________________________________________________________________________


|x1= <code>[ "TAG_aVeryUniqueID", [[false]] ]  [[call]] [[BIS_fnc_blackOut]];</code> |=
|p3= fadeSpeed: [[Number]] - (Optional, default 2) transition duration (if ''smoothing'' is [[true]])
____________________________________________________________________________________________


| [[BIS_fnc_blackIn]] |SEEALSO=
|r1= [[Nothing]]
}}


|x1= <sqf>["TAG_aVeryUniqueID", false, 5] call BIS_fnc_blackOut;</sqf>


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

Latest revision as of 23:11, 12 July 2022

Arma 3 logo black.png1.00
Hover & click on the images for description

Description

Description:
Register a black screen. Start the black screen when the first request is registered.
Execution:
call
Groups:
GUI

Syntax

Syntax:
[id, smoothing, fadeSpeed] call BIS_fnc_blackOut
Parameters:
id: String - black screen id used for registration (case sensitive)
smoothing: Boolean - (Optional, default true) smooth transition - false for an immediate blackout
fadeSpeed: Number - (Optional, default 2) transition duration (if smoothing is true)
Return Value:
Nothing

Examples

Example 1:
["TAG_aVeryUniqueID", false, 5] call BIS_fnc_blackOut;

Additional Information

See also:
BIS_fnc_blackIn

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
Retrieved from "https://community.bistudio.com/wiki?title=BIS_fnc_blackOut&oldid=327267"