BIS fnc blackOut: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Generated by BIS_fnc_exportFunctionsToWiki)
 
m (Text replacement - " |s1=[" to " |s1= [")
 
(26 intermediate revisions by 4 users not shown)
Line 1: Line 1:
{{RV|type=function


{{Function|= Comments
|game1= arma3
____________________________________________________________________________________________
|version1= 1.00


| arma3 |= Game name
|gr1= GUI


|1.00|= Game version
|descr= Register a black screen. Start the black screen when the first request is registered.
____________________________________________________________________________________________


| <pre>/*
|s1= [id, smoothing, fadeSpeed] call [[BIS_fnc_blackOut]]


Description:
|p1= id: [[String]] - black screen id used for registration (case sensitive)
Register a black screen. Start the black screen when the first request is registered.


Parameter(s):
|p2= smoothing: [[Boolean]] - (Optional, default [[true]]) smooth transition - [[false]] for an immediate blackout
0: _id:string - black screen id used for registration
1: _smooth:bool (optional, default: true) - should fade smoothly?


Remarks:
|p3= fadeSpeed: [[Number]] - (Optional, default 2) transition duration (if ''smoothing'' is [[true]])
* Screen id is case sensitive.
* If a function requires a black screen, use it's name as an id.


Returns:
|r1= [[Nothing]]
nil


Example:
|x1= <sqf>["TAG_aVeryUniqueID", false, 5] call BIS_fnc_blackOut;</sqf>
["BIS_ScreenSetup"] call BIS_fnc_blackOut;
*/
 
#define FADE_SPEED 2
 
 
</pre><small>''(Placeholder description extracted from the function header by [[BIS_fnc_exportFunctionsToWiki]])''</small> |= Description
____________________________________________________________________________________________
 
| <!-- [] call [[BIS_fnc_blackOut]]; --> |= Syntax
 
|p1= |= Parameter 1
 
| |= Return value
____________________________________________________________________________________________
 
|x1= <code></code> |=
____________________________________________________________________________________________
 
| |= See also


|seealso= [[BIS_fnc_blackIn]]
}}
}}
<h3 style="display:none">Notes</h3>
<dl class="command_description">
<!-- Note Section BEGIN -->
<!-- Note Section END -->
</dl>
<h3 style="display:none">Bottom Section</h3>
[[Category:Function Group: Misc|{{uc:blackOut}}]]
[[Category:Functions|{{uc:blackOut}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:blackOut}}]]

Latest revision as of 23:11, 12 July 2022

Arma 3 logo black.png1.00
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
Retrieved from "https://community.bistudio.com/wiki?title=BIS_fnc_blackOut&oldid=327267"