BIS fnc blackOut: Difference between revisions
Jump to navigation
Jump to search
Lou Montana (talk | contribs) m (Text replacement - "| arma 3 |Game name=" to "| arma3 |Game name=") |
Lou Montana (talk | contribs) m (Text replacement - "_{10,} " to "") |
||
| Line 1: | Line 1: | ||
{{Function|Comments= | {{Function|Comments= | ||
| arma3 |Game name= | | arma3 |Game name= | ||
| Line 7: | Line 6: | ||
|gr1 = GUI |GROUP1= | |gr1 = GUI |GROUP1= | ||
| Register a black screen. Start the black screen when the first request is registered. |DESCRIPTION= | | Register a black screen. Start the black screen when the first request is registered. |DESCRIPTION= | ||
| [id, smoothing, fadeSpeed] 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= | ||
| Line 20: | Line 16: | ||
|p3= fadeSpeed: [[Number]] - (Optional, default 2) transition duration (if ''smoothing'' is [[true]]) |PARAMETER3= | |p3= fadeSpeed: [[Number]] - (Optional, default 2) transition duration (if ''smoothing'' is [[true]]) |PARAMETER3= | ||
| [[Nothing]] |RETURNVALUE= | | [[Nothing]] |RETURNVALUE= | ||
|x1= <code>["TAG_aVeryUniqueID", [[false]], 5] [[call]] [[BIS_fnc_blackOut]];</code> |EXAMPLE1= | |x1= <code>["TAG_aVeryUniqueID", [[false]], 5] [[call]] [[BIS_fnc_blackOut]];</code> |EXAMPLE1= | ||
| [[BIS_fnc_blackIn]] |SEEALSO= | | [[BIS_fnc_blackIn]] |SEEALSO= | ||
Revision as of 22:42, 16 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