BIS fnc blackOut: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "<h3 style="display:none">Bottom Section</h3>" to "")
m (Text replacement - " |s1=[" to " |s1= [")
 
(11 intermediate revisions by the same user not shown)
Line 1: Line 1:
{{Function
{{RV|type=function


| arma3
|game1= arma3
|version1= 1.00


|1.00
|gr1= GUI


|gr1 = GUI
|descr= Register a black screen. Start the black screen when the first request is registered.


| Register a black screen. Start the black screen when the first request is registered.
|s1= [id, smoothing, fadeSpeed] call [[BIS_fnc_blackOut]]
 
| [id, smoothing, fadeSpeed] call [[BIS_fnc_blackOut]]


|p1= id: [[String]] - black screen id used for registration (case sensitive)
|p1= id: [[String]] - black screen id used for registration (case sensitive)
Line 17: Line 16:
|p3= fadeSpeed: [[Number]] - (Optional, default 2) transition duration (if ''smoothing'' is [[true]])
|p3= fadeSpeed: [[Number]] - (Optional, default 2) transition duration (if ''smoothing'' is [[true]])


| [[Nothing]]
|r1= [[Nothing]]


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


| [[BIS_fnc_blackIn]]
|seealso= [[BIS_fnc_blackIn]]
}}
}}

Latest revision as of 23:11, 12 July 2022

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