BIS fnc blackOut: Difference between revisions

From Bohemia Interactive Community
m (1 revision)
m (pf)
Line 1: Line 1:
{{Function|= Comments
{{Function|= Comments
____________________________________________________________________________________________
____________________________________________________________________________________________


| arma3 |= Game name
| arma 3 |= Game name


|1.00|= Game version
|1.00|= Game version
____________________________________________________________________________________________
____________________________________________________________________________________________


| <pre>/*
| Register a black screen. Start the black screen when the first request is registered. |= Description
____________________________________________________________________________________________


Description:
| [id,smoothing] call [[BIS_fnc_blackOut]] |= Syntax
Register a black screen. Start the black screen when the first request is registered.
____________________________________________________________________________________________


Parameter(s):
|p1= id: [[String]] - Black screen id used for registration (case sensitive)|= Parameter 1
0: _id:string - black screen id used for registration
|p2= smoothing: [[Boolean]] - (Optional, default [[true]] Smoothing|= Parameter 2
1: _smooth:bool (optional, default: true) - should fade smoothly?
 
Remarks:
* Screen id is case sensitive.
* If a function requires a black screen, use it's name as an id.
 
Returns:
nil
 
Example:
["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
| [[Nothing]]|= Return value
 
|p1= |= Parameter 1
 
| |= Return value
____________________________________________________________________________________________
____________________________________________________________________________________________


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


| |= See also
| [[BIS_fnc_blackIn]] |= See also
}}


}}


<h3 style="display:none">Notes</h3>
<h3 style="display:none">Notes</h3>

Revision as of 15:59, 5 June 2018

Arma 3 logo black.png 1.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:
Uncategorised

Syntax

Syntax:
[id,smoothing] call BIS_fnc_blackOut
Parameters:
id: String - Black screen id used for registration (case sensitive)
smoothing: Boolean - (Optional, default true Smoothing
Return Value:
Nothing

Examples

Example 1:
[ "TAG_aVeryUniqueID", false ] 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

Retrieved from "https://community.bistudio.com/wiki?title=BIS_fnc_blackOut&oldid=108058"