BIS fnc blackOut: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
(Add missing parameter)
m (Some wiki formatting)
Line 13: Line 13:
____________________________________________________________________________________________
____________________________________________________________________________________________


|p1= id: [[String]] - Black screen id used for registration (case sensitive) |PARAMETER1=
|p1= id: [[String]] - black screen id used for registration (case sensitive) |PARAMETER1=


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


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



Revision as of 12:00, 1 July 2020

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:
Uncategorised

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


Notes

Bottom Section