startLoadingScreen

Description

Shows loading screen with the given text, using the given resource. While loading screen is shown, simulation and scene drawing is disabled, user control is disabled, mouse cursor is hidden, scripts run at full speed (50ms per frame instead of 3ms per frame for Scheduled Scripts).

Note

Warning

• The loading screen does not end by itself and absolutely needs a call to endLoadingScreen command
• Game simulation is disabled during Loading Screen operation (at least in single player):
  • do not use the sleep command between startLoadingScreen and endLoadingScreen as it may freeze the game - use uiSleep instead
  • waitUntil can be used to wait for variable initialisation or script loading

Note

Arma 3: - Use BIS_fnc_startLoadingScreen to prevent potential usage conflicts.

• The loading screen can be force-ended with the ENDLOAD cheat code.

Syntax

startLoadingScreen [text, resource]

Parameters:

• text: String
• resource: String - (Optional)

Returns: Nothing

Examples

Example 1

startLoadingScreen ["Loading My Mission, please wait..."];

Example 2

startLoadingScreen ["Can't skip loading time...", "MyLoadingRsc"];

Example 3

startLoadingScreen ["Loading My Mission"];
// code
progressLoadingScreen 0.5;
// code
endLoadingScreen;

Example 4

// 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 { uiSleep .1; scriptDone _handle || diag_tickTime > _maxTime };
endLoadingScreen;

See also

endLoadingScreen · progressLoadingScreen · BIS_fnc_startLoadingScreen · import (Config)