endLoadingScreen: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "\[\[Category:[ _]?Scripting[ _]Commands[ _]Take[ _]On[ _]Helicopters(\|.*)?\]\]" to "{{GameCategory|tkoh|Scripting Commands}}")
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}}")
 
(32 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Command|Comments=
{{RV|type=command
____________________________________________________________________________________________


| arma2 |Game name=
|game1= arma2
|version1= 1.00


|1.00|Game version=
|game2= arma2oa
|version2= 1.50


|eff= local |MP Effect=
|game3= tkoh
|version3= 1.00


|gr1= System |GROUP1=
|game4= arma3
____________________________________________________________________________________________
|version4= 0.50


| Finishes loading screen started by [[startLoadingScreen]].
|eff= local


{{Feature|arma3 | Use [[BIS_fnc_endLoadingScreen]] to prevent potential usage conflicts.}} |DESCRIPTION=
|gr1= System
____________________________________________________________________________________________


| [[endLoadingScreen]] |SYNTAX=
|descr= Finishes loading screen started by [[startLoadingScreen]].


| [[Nothing]] |RETURNVALUE=
{{Feature|arma3|Use [[BIS_fnc_endLoadingScreen]] to prevent potential usage conflicts.}}


|x1= <code>[[startLoadingScreen]] ["Loading My Mission"];
{{Feature|arma3|The loading screen can be force-ended with the {{Link|Arma 3: Cheats#ENDLOAD|ENDLOAD cheat code}}.}}
{{cc|code}}
[[progressLoadingScreen]] 0.5;
{{cc|code}}
[[endLoadingScreen]];</code>|EXAMPLE1=


|x2= <code>{{cc|this structure prevents error-prone or lengthy code to miss [[endLoadingScreen]].}}
|s1= [[endLoadingScreen]]
[[private]] _maxTime = [[diag_tickTime]] + 30; {{cc|max 30s of loading}}


[[startLoadingScreen]] ["Loading"];
|r1= [[Nothing]]
[[private]] _handle = [] [[spawn]] {
{{cc|code that may crash or take too long}}
};


[[waitUntil]] { sleep .01; [[scriptDone]] _handle {{!}}{{!}} [[diag_tickTime]] > _maxTime };
|x1= <sqf>
[[endLoadingScreen]];</code> |EXAMPLE2=
startLoadingScreen ["Loading My Mission"];
____________________________________________________________________________________________
// code
progressLoadingScreen 0.5;
// code
endLoadingScreen;
</sqf>


| [[startLoadingScreen]], [[progressLoadingScreen]], [[BIS_fnc_endLoadingScreen]] |SEEALSO=
|x2= <sqf>
}}
// this structure prevents error-prone or lengthy code to miss endLoadingScreen.
private _maxTime = diag_tickTime + 30; // max 30s of loading


<h3 style='display:none'>Notes</h3>
startLoadingScreen ["Loading"];
<dl class='command_description'>
private _handle = 0 spawn {
<!-- Note Section BEGIN -->
// code that may crash or take too long
};


<!-- Note Section END -->
waitUntil { sleep .01; scriptDone _handle || diag_tickTime > _maxTime };
</dl>
endLoadingScreen;
</sqf>


<h3 style='display:none'>Bottom Section</h3>
|seealso= [[startLoadingScreen]] [[progressLoadingScreen]] [[BIS_fnc_endLoadingScreen]]
 
}}
{{GameCategory|arma3|Scripting Commands}}
{{GameCategory|tkoh|Scripting Commands}}

Latest revision as of 09:44, 6 September 2024

Logo A2.png1.00A2 OA Logo.png1.50tkoh logo small.png1.00Arma 3 logo black.png0.50
LELocal
Hover & click on the images for description

Description

Description:
Finishes loading screen started by startLoadingScreen.
Arma 3
Use BIS_fnc_endLoadingScreen to prevent potential usage conflicts.
Arma 3
The loading screen can be force-ended with the ENDLOAD cheat code.
Groups:
System

Syntax

Syntax:
endLoadingScreen
Return Value:
Nothing

Examples

Example 1:
startLoadingScreen ["Loading My Mission"]; // code progressLoadingScreen 0.5; // code endLoadingScreen;
Example 2:
// this structure prevents error-prone or lengthy code to miss endLoadingScreen. private _maxTime = diag_tickTime + 30; // max 30s of loading startLoadingScreen ["Loading"]; private _handle = 0 spawn { // code that may crash or take too long }; waitUntil { sleep .01; scriptDone _handle || diag_tickTime > _maxTime }; endLoadingScreen;

Additional Information

See also:
startLoadingScreen progressLoadingScreen BIS_fnc_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=endLoadingScreen&oldid=369454"