BIS fnc blackOut: Difference between revisions
Jump to navigation
Jump to search
Lou Montana (talk | contribs) m (Text replacement - "|= Game name " to "|Game name= ") |
Lou Montana (talk | contribs) (Add missing parameter) |
||
| Line 10: | Line 10: | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
| [id,smoothing] call [[BIS_fnc_blackOut]] |SYNTAX= | | [id, smoothing, fadeSpeed] call [[BIS_fnc_blackOut]] |SYNTAX= | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
|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]] | |||
|p2= smoothing: [[Boolean]] - (Optional, default [[true]]) smooth transition - [[false]] for an immediate blackout |PARAMETER2= | |||
|p3= fadeSpeed: [[Number]] - (Optional, default 2) transition duration (if ''smoothing'' is [[true]]) |PARAMETER3= | |||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
| [[Nothing]]|RETURNVALUE= | | [[Nothing]] |RETURNVALUE= | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
|x1= <code>[ "TAG_aVeryUniqueID", [[false]] ] [[call]] [[BIS_fnc_blackOut]];</code> |= | |x1= <code>["TAG_aVeryUniqueID", [[false]], 5] [[call]] [[BIS_fnc_blackOut]];</code> |EXAMPLE1= | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
| Line 36: | Line 39: | ||
<h3 style="display:none">Bottom Section</h3> | <h3 style="display:none">Bottom Section</h3> | ||
[[Category:Function Group: Misc|{{uc:blackOut}}]] | [[Category:Function Group: Misc|{{uc:blackOut}}]] | ||
Revision as of 10:58, 1 July 2020
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