BIS fnc startLoadingScreen: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (GVI http://dev.arma3.com/post/spotrep-00004)
(Page filling)
Line 1: Line 1:
{{Function|= Comments
{{Function|= Comments
____________________________________________________________________________________________
____________________________________________________________________________________________
Line 8: Line 7:
____________________________________________________________________________________________
____________________________________________________________________________________________


| <pre>/*
| Register a loading screen. Start the loading when it is the first one registered. |= Description
 
____________________________________________________________________________________________
Description:
Register a loading screen. Start the loading when it's the first one registered.
 
Parameter(s):
0: STRING - screen ID, will be used in BIS_fnc_endLoadingScreen
1 (Optional): STRING - loading screen layout


Returns:
| [screenId, layout] call [[BIS_fnc_startLoadingScreen]] |= Syntax
BOOL - true when registered
*/
</pre><small>''(Placeholder description extracted from the function header by [[BIS_fnc_exportFunctionsToWiki]])''</small> |= Description
____________________________________________________________________________________________


| <!-- [] call [[BIS_fnc_startLoadingScreen]]; --> |= Syntax
|p1= screenId: [[String]] - screen ID, will be used in [[BIS_fnc_endLoadingScreen]] |= Parameter 1


|p1= |= Parameter 1
|p2= layout: [[String]] - loading text. ''has no effect in {{arma3}}'' |= Parameter 2


| |= Return value
| [[Boolean]] - true when registered |= Return value
____________________________________________________________________________________________
____________________________________________________________________________________________


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


| |= See also
| [[BIS_fnc_endLoadingScreen]], [[startLoadingScreen]], [[endLoadingScreen]] |= See also
 
}}
}}



Revision as of 19:47, 26 April 2018

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

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