BIS fnc blackIn: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "| arma 3 |Game name=" to "| arma3 |Game name=")
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=
____________________________________________________________________________________________


| Unregister a black screen. When none other black screen is registered, fade it out. |DESCRIPTION=
| Unregister a black screen. When none other black screen is registered, fade it out. |DESCRIPTION=
____________________________________________________________________________________________


| [id, smoothing, fadeSpeed] 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=
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_blackIn]];</code> |EXAMPLE1=
|x1= <code>["TAG_aVeryUniqueID", [[false]], 5] [[call]] [[BIS_fnc_blackIn]];</code> |EXAMPLE1=
____________________________________________________________________________________________


| [[BIS_fnc_blackOut]] |SEEALSO=
| [[BIS_fnc_blackOut]] |SEEALSO=

Revision as of 23:33, 16 January 2021

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


Notes

Bottom Section