BIS fnc startLoadingScreen: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - " <h3 style="display:none">Notes</h3> <dl class="command_description"> <!-- Note Section BEGIN --> <!-- Note Section END --> </dl> " to "")
m (Text replacement - " *\| *([Cc]omments|COMMENTS|[Gg]ame [Nn]ame|Game [Vv]ersion|Game Version \(number surrounded by NO SPACES\)|Multiplayer Arguments \("local" or "global"\)|Multiplayer Effects \("local" or "global"\)|Multiplayer Execution \("server" o...)
Line 1: Line 1:
{{Function|Comments=
{{Function


| arma3 |Game name=
| arma3


|0.58|= Game version
|0.58|= Game version


|gr1 = Systems |GROUP1=
|gr1 = Systems


| 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.


| [screenId, layout] call [[BIS_fnc_startLoadingScreen]] |SYNTAX=
| [screenId, layout] call [[BIS_fnc_startLoadingScreen]]


|p1= screenId: [[String]] - screen ID, will be used in [[BIS_fnc_endLoadingScreen]] |PARAMETER1=
|p1= screenId: [[String]] - screen ID, will be used in [[BIS_fnc_endLoadingScreen]]


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


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


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


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



Revision as of 23:48, 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

Bottom Section