BIS fnc blackIn: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "|= Game name" to "|Game name=")
(Add missing parameter)
Line 10: Line 10:
____________________________________________________________________________________________
____________________________________________________________________________________________


| [id,smoothing] call [[BIS_fnc_blackIn]] |SYNTAX=
| [id, smoothing, fadeSpeed] call [[BIS_fnc_blackIn]] |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]] Smoothing|PARAMETER2=
 
|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_blackIn]];</code> |=
|x1= <code>["TAG_aVeryUniqueID", [[false]], 5] [[call]] [[BIS_fnc_blackIn]];</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:blackIn}}]]
[[Category:Function Group: Misc|{{uc:blackIn}}]]
[[Category:Functions|{{uc:blackIn}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:blackIn}}]]

Revision as of 11:00, 1 July 2020

Hover & click on the images for description

Description

Description:
Unregister a black screen. When none other black screen is registered, fade it out.
Execution:
call
Groups:
Uncategorised

Syntax

Syntax:
[id, smoothing, fadeSpeed] call BIS_fnc_blackIn
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_blackIn;

Additional Information

See also:
BIS_fnc_blackOut

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