BIS fnc startLoadingScreen: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
mNo edit summary
m (Text replacement - "_{10,} " to "")
Line 1: Line 1:
{{Function|Comments=
{{Function|Comments=
____________________________________________________________________________________________


| arma3 |Game name=
| arma3 |Game name=
Line 7: Line 6:


|gr1 = Systems |GROUP1=
|gr1 = Systems |GROUP1=
____________________________________________________________________________________________


| Register a loading screen. Start the loading when it is the first one registered. |DESCRIPTION=
| Register a loading screen. Start the loading when it is the first one registered. |DESCRIPTION=
____________________________________________________________________________________________


| [screenId, layout] call [[BIS_fnc_startLoadingScreen]] |SYNTAX=
| [screenId, layout] call [[BIS_fnc_startLoadingScreen]] |SYNTAX=
Line 19: Line 16:


| [[Boolean]] - true when registered |RETURNVALUE=
| [[Boolean]] - true when registered |RETURNVALUE=
____________________________________________________________________________________________


|x1= <code>["myLoadingScreen", "Loading… wait for my splendid™ mission!"] [[call]] [[BIS_fnc_startLoadingScreen]];
|x1= <code>["myLoadingScreen", "Loading… wait for my splendid™ mission!"] [[call]] [[BIS_fnc_startLoadingScreen]];
[[uiSleep]] 3;
[[uiSleep]] 3;
"myLoadingScreen" [[call]] [[BIS_fnc_endLoadingScreen]];</code> |EXAMPLE1=
"myLoadingScreen" [[call]] [[BIS_fnc_endLoadingScreen]];</code> |EXAMPLE1=
____________________________________________________________________________________________


| [[BIS_fnc_endLoadingScreen]], [[startLoadingScreen]], [[endLoadingScreen]] |SEEALSO=
| [[BIS_fnc_endLoadingScreen]], [[startLoadingScreen]], [[endLoadingScreen]] |SEEALSO=

Revision as of 00:55, 17 January 2021

Hover & click on the images for description

Description

Description:
Register a loading screen. Start the loading when it is the first one registered.
Execution:
call
Groups:
Systems

Syntax

Syntax:
[screenId, layout] call BIS_fnc_startLoadingScreen
Parameters:
screenId: String - screen ID, will be used in BIS_fnc_endLoadingScreen
layout: String - loading text. has no effect in Arma 3
Return Value:
Boolean - true when registered

Examples

Example 1:
["myLoadingScreen", "Loading… wait for my splendid™ mission!"] call BIS_fnc_startLoadingScreen; uiSleep 3; "myLoadingScreen" call BIS_fnc_endLoadingScreen;

Additional Information

See also:
BIS_fnc_endLoadingScreenstartLoadingScreenendLoadingScreen

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