BIS fnc blackOut: Difference between revisions
Jump to navigation
Jump to search
Lou Montana (talk | contribs) m (Text replacement - " <h3 style="display:none">Notes</h3> <dl class="command_description"> <!-- Note Section BEGIN --> <!-- Note Section END --> </dl>" to "") |
Lou Montana (talk | contribs) m (Text replacement - " *\| *([Cc]omments|COMMENTS|[Gg]ame [Nn]ame|Game [Vv]ersion|Game Version \(number surrounded by NO SPACES\)|Multiplayer Arguments \("local" or "global"\)|Multiplayer Effects \("local" or "global"\)|Multiplayer Execution \("server" o...) |
||
| Line 1: | Line 1: | ||
{{Function | {{Function | ||
| arma3 | | arma3 | ||
|1.00 | |1.00 | ||
|gr1 = GUI | |gr1 = GUI | ||
| 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. | ||
| [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) | ||
|p2= smoothing: [[Boolean]] - (Optional, default [[true]]) smooth transition - [[false]] for an immediate blackout | |p2= smoothing: [[Boolean]] - (Optional, default [[true]]) smooth transition - [[false]] for an immediate blackout | ||
|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]] | | [[Nothing]] | ||
|x1= <code>["TAG_aVeryUniqueID", [[false]], 5] [[call]] [[BIS_fnc_blackOut]];</code> | |x1= <code>["TAG_aVeryUniqueID", [[false]], 5] [[call]] [[BIS_fnc_blackOut]];</code> | ||
| [[BIS_fnc_blackIn]] | | [[BIS_fnc_blackIn]] | ||
}} | }} | ||
Revision as of 22:39, 17 January 2021
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