startLoadingScreen

From Bohemia Interactive Community
Jump to navigation Jump to search
Introduced with Arma 2 version 1.00
  

Click on the images for descriptions

Introduced in

Game:
Arma 2
Version:
1.00

Description

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). The loading screen does not end by itself and needs endLoadingScreen command, so make sure there is one at the end of loading operation.
NOTE: The game simulation is disabled during Loading Screen operation (at least in SP), therefore any use of sleep command will pause the game indefinitely. If you have to "sleep", use uiSleep

By default (if custom resource is not provided) startLoadingScreen will use "RscDisplayNotFreeze" resource. If you are using custom resource (could be also defined in description.ext), the following resource's controls are supported by the engine:

  • idc = 101; - text (type = 0;) or picture (type = 48;). The text will be set to the text provided by the command param.
  • idc = 103; - progress (type = 8;) or animated texture (type = 45;). This control indicates global hardcoded mission loading progress and is useless after mission is loaded.
  • idc = 104; - progress (type = 8;). This control's progress is initially set to 0 and can be manipulated with progressLoadingScreen command.

Syntax

Syntax:
startLoadingScreen [text, resource]
Parameters:
[text, resource]: Array -
text: String
resource (Optional): String
Return Value:
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"]; //Batch of code //Batch of code //Batch of code progressLoadingScreen 0.5; //Batch of code //Batch of code //Batch of code endLoadingScreen;

Additional Information

Multiplayer:
-
See also:
endLoadingScreenprogressLoadingScreen

Notes

Only post proven facts here. Report bugs on the feedback tracker. Use the talk page or the forums for discussions.
Add New Note | How To

Notes

Posted on July 15, 2009 - 01:47 (CEST)
Lou Montana
As it stops simulation as well as scene drawing, be sure not to put any sleep (or waitUntil if you are checking for in-game changes ; waitUntil for var initialization or script loading is ok) command between startLoadingScreen and endLoadingScreen.
Posted on January 18, 2010 - 08:07 (CEST)
Lou Montana
edit 10:15 : Whatever transparence you define in your own resource, there will be a black screen to cache loading.
It's up to you to choose a nice blue background :-)

Resource has to be defined in description.ext ; it must NOT be defined as RscTitles ! Here is an example : Show text


Bottom Section

Posted on February 19, 2015 - 12:31 (UTC)
Bull A
Based on what Lou Montana has previously said, the simulation does become disabled upon using this command. If you wish to use a delay 'sleep' will not work. The work around would be to use 'uiSleep'
Posted on November 21, 2015 - 18:38 (UTC)
Killzone Kid
In Arma 3 default loading screen has no control do display text. The description of the command now contains information what is needed to create custom loading screen resource.