BIS fnc startLoadingScreen: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (template:command argument fix)
m (Text replacement - "with [https://community.bistudio.com/wiki/Arma_3:_Cheats#ENDLOAD ENDLOAD cheat code]" to "with the {{Link|Arma 3: Cheats#ENDLOAD|ENDLOAD cheat code}}")
 
(31 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Function|= Comments
{{RV|type=function
____________________________________________________________________________________________


| arma3 |= Game name
|game1= arma3
|version1= 0.58


|0.58|= Game version
|gr1= Systems
____________________________________________________________________________________________


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


| [screenId, layout] call [[BIS_fnc_startLoadingScreen]] |SYNTAX=
{{Feature|arma3|The loading screen can be force-ended with the {{Link|Arma 3: Cheats#ENDLOAD|ENDLOAD cheat code}}.}}


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


|p2= layout: [[String]] - loading text. ''has no effect in {{arma3}}'' |PARAMETER2=
|p1= screenId: [[String]] - screen ID, will be used in [[BIS_fnc_endLoadingScreen]]


| [[Boolean]] - true when registered |RETURNVALUE=
|p2= layout: [[String]] - loading text. ''has no effect in {{arma3}}''
____________________________________________________________________________________________


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


| [[BIS_fnc_endLoadingScreen]], [[startLoadingScreen]], [[endLoadingScreen]] |SEEALSO=
|x1= <sqf>["myLoadingScreen", "Loading… wait for my splendid™ mission!"] call BIS_fnc_startLoadingScreen;
uiSleep 3;
"myLoadingScreen" call BIS_fnc_endLoadingScreen;</sqf>
 
|seealso= [[BIS_fnc_endLoadingScreen]] [[startLoadingScreen]] [[endLoadingScreen]]
}}
}}
<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:startLoadingScreen}}]]
[[Category:Functions|{{uc:startLoadingScreen}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:startLoadingScreen}}]]

Latest revision as of 09:44, 6 September 2024

Arma 3 logo black.png0.58
Hover & click on the images for description

Description

Description:
Register a loading screen. Start the loading when it is the first one registered.
Arma 3
The loading screen can be force-ended with the ENDLOAD cheat code.
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_endLoadingScreen startLoadingScreen endLoadingScreen

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
Retrieved from "https://community.bistudio.com/wiki?title=BIS_fnc_startLoadingScreen&oldid=369455"