BIS fnc blackIn: Difference between revisions

Latest revision as of 23:11, 12 July 2022

1.00

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:: GUI

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

@@ Line 1: / Line 1: @@
-{{Function|Comments=
+{{RV|type=function
-____________________________________________________________________________________________
-| arma 3 |Game name=
+|game1= arma3
+|version1= 1.00
-|1.00|Game version=
+|gr1= GUI
-____________________________________________________________________________________________
-| Unregister a black screen. When none other black screen is registered, fade it out. |DESCRIPTION=
+|descr= Unregister a black screen. When none other black screen is registered, fade it out.
-____________________________________________________________________________________________
-| [id, smoothing, fadeSpeed] call [[BIS_fnc_blackIn]] |SYNTAX=
+|s1= [id, smoothing, fadeSpeed] call [[BIS_fnc_blackIn]]
-____________________________________________________________________________________________
-|p1= id: [[String]] - black screen id used for registration (case sensitive)|PARAMETER1=
+|p1= id: [[String]] - black screen id used for registration (case sensitive)
-|p2= smoothing: [[Boolean]] - (Optional, default [[true]]) smooth transition - [[false]] for an immediate blackout |PARAMETER2=
+|p2= smoothing: [[Boolean]] - (Optional, default [[true]]) smooth transition - [[false]] for an immediate blackout
-|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]])
-____________________________________________________________________________________________
-| [[Nothing]] |RETURNVALUE=
+|r1= [[Nothing]]
-____________________________________________________________________________________________
-|x1= <code>["TAG_aVeryUniqueID", [[false]], 5] [[call]] [[BIS_fnc_blackIn]];</code> |EXAMPLE1=
+|x1= <sqf>["TAG_aVeryUniqueID", false, 5] call BIS_fnc_blackIn;</sqf>
-____________________________________________________________________________________________
-| [[BIS_fnc_blackOut]] |SEEALSO=
+|seealso= [[BIS_fnc_blackOut]]
 }}
-<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:blackIn}}]]