BIS fnc endLoadingScreen: Difference between revisions

Latest revision as of 09:44, 6 September 2024

Hover & click on the images for description

Description:: Unregister a loading screen. When none other remains, end the loading.
The loading screen can be force-ended with the ENDLOAD cheat code.
Execution:: call
Groups:: GUI

Syntax:: screenId call BIS_fnc_endLoadingScreen
Parameters:: screenId: String - screen ID, used in BIS_fnc_startLoadingScreen
Return Value:: Boolean - true when unregistered

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

: 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

@@ Line 1: / Line 1: @@
-{{Function
+{{RV|type=function
-| arma3
+|game1= arma3
+|version1= 0.58
-|0.58
+|gr1= GUI
-|gr1 = GUI
+|descr= Unregister a loading screen. When none other remains, end the loading.
+{{Feature|arma3|The loading screen can be force-ended with the {{Link|Arma 3: Cheats#ENDLOAD|ENDLOAD cheat code}}.}}
-| Unregister a loading screen. When none other remains, end the loading.
+|s1= screenId call [[BIS_fnc_endLoadingScreen]]
-| screenId call [[BIS_fnc_endLoadingScreen]]
 |p1= screenId: [[String]] - screen ID, used in [[BIS_fnc_startLoadingScreen]]
-| [[Boolean]] - true when unregistered
+|r1= [[Boolean]] - true when unregistered
-|x1= <code>["myLoadingScreen", "Loading… wait for my splendid™ mission!"] [[call]] [[BIS_fnc_startLoadingScreen]];
+|x1= <sqf>["myLoadingScreen", "Loading… wait for my splendid™ mission!"] call BIS_fnc_startLoadingScreen;
-[[uiSleep]] 3;
+uiSleep 3;
-"myLoadingScreen" [[call]] [[BIS_fnc_endLoadingScreen]];</code>
+"myLoadingScreen" call BIS_fnc_endLoadingScreen;</sqf>
-| [[BIS_fnc_startLoadingScreen]], [[startLoadingScreen]], [[endLoadingScreen]]
+|seealso= [[BIS_fnc_startLoadingScreen]] [[startLoadingScreen]] [[endLoadingScreen]]
 }}
-[[Category:Functions|{{uc:endLoadingScreen}}]]
-[[Category:{{Name|arma3}}: Functions|{{uc:endLoadingScreen}}]]