startLoadingScreen: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
mNo edit summary
(removed alt syntax, really is same syntax optional param)
Line 10: Line 10:
____________________________________________________________________________________________
____________________________________________________________________________________________


| '''startLoadingScreen''' [text] |= Syntax
| '''startLoadingScreen''' [text, resource] |= Syntax


|p1= [text]: [[Array]] -  |= PARAMETER1  
|p1= [text, resource]: [[Array]] -  |= PARAMETER1  


|p2= text: [[String]] |= PARAMETER2  
|p2= text: [[String]] |= PARAMETER2  


|p3= |= PARAMETER3
|p3= resource (Optional): [[String]]  |= Parameter3


| [[Nothing]] |= RETURNVALUE  
| [[Nothing]] |= RETURNVALUE  


|s2= '''startLoadingScreen''' [text, resource]  |=Syntax
|p21= [text, resource]: [[Array]] |=Parameter1
|p22= text: [[String]]  |= Parameter2
|p23= resource: [[String]]  |= Parameter3
|r2= [[Nothing]] |= RETURNVALUE


|x1= <code>[[startLoadingScreen]] ["Loading My Mission, please wait..."];</code>|= EXAMPLE1
|x1= <code>[[startLoadingScreen]] ["Loading My Mission, please wait..."];</code>|= EXAMPLE1

Revision as of 12:55, 15 May 2015

Hover & click on the images for description

Description

Description:
Shows loading screen with the given text, using the given resource. While loading screen is shown, simulation and scene drawing is disabled, scripts run at full speed.
Groups:
Uncategorised

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"];

Additional Information

See also:
endLoadingScreenprogressLoadingScreen

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

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 :

// basic defines // class RscText { type = 0; idc = -1; x = 0; y = 0; h = 0.037; w = 0.3; style = 0x100; font = Zeppelin32; SizeEx = 0.03921; colorText[] = {1,1,1,1}; colorBackground[] = {0, 0, 0, 0}; linespacing = 1; }; class RscPicture { access=0; type=0; idc=-1; style=48; colorBackground[]={0,0,0,0}; colorText[]={1,1,1,1}; font="TahomaB"; sizeEx=0; lineSpacing=0; text=""; }; class RscLoadingText : RscText { style = 2; x = 0.323532; y = 0.666672; w = 0.352944; h = 0.039216; sizeEx = 0.03921; colorText[] = {0.543,0.5742,0.4102,1.0}; }; class RscProgress { x = 0.344; y = 0.619; w = 0.313726; h = 0.0261438; texture = "\ca\ui\data\loadscreen_progressbar_ca.paa"; colorFrame[] = {0,0,0,0}; colorBar[] = {1,1,1,1}; }; class RscProgressNotFreeze { idc = -1; type = 45; style = 0; x = 0.022059; y = 0.911772; w = 0.029412; h = 0.039216; texture = "#(argb,8,8,3)color(0,0,0,0)"; }; // // the loading screen itself // class Harrier_loadingScreen { idd = -1; duration = 10e10; fadein = 0; fadeout = 0; name = "loading screen"; class controlsBackground { class blackBG : RscText { x = safezoneX; y = safezoneY; w = safezoneW; h = safezoneH; text = ""; colorText[] = {0,0,0,0}; colorBackground[] = {0,0,0,1}; }; class nicePic : RscPicture { style = 48 + 0x800; // ST_PICTURE + ST_KEEP_ASPECT_RATIO x = safezoneX + safezoneW/2 - 0.25; y = safezoneY + safezoneH/2 - 0.2; w = 0.5; h = 0.4; text = "img\nicePic.paa"; }; }; class controls { class Title1 : RscLoadingText { text = "$STR_LOADING"; // "Loading" text in the middle of the screen }; class CA_Progress : RscProgress // progress bar, has to have idc 104 { idc = 104; type = 8; // CT_PROGRESS style = 0; // ST_SINGLE texture = "\ca\ui\data\loadscreen_progressbar_ca.paa"; }; class CA_Progress2 : RscProgressNotFreeze // progress bar that will go reverse { idc = 103; }; class Name2: RscText // the text on the top-left { idc = 101; x = 0.05; y = 0.029412; w = 0.9; h = 0.04902; text = ""; sizeEx = 0.05; colorText[] = {0.543,0.5742,0.4102,1.0}; }; }; };

↑ Back to spoiler's top

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'