scriptDone: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "<h3 style="display:none">Bottom Section</h3> " to "")
m (Text replacement - " *\| *([Cc]omments|COMMENTS|Game|[Gg]ame [Nn]ame( +[0-9])?|Game [Vv]ersion( +[0-9])?|Game Version \(number surrounded by NO SPACES\)|Arguments in MP|MP[Aa]rg|Multiplayer Arguments( \("local" or "global"\))?|Effects|Execution|Effects...)
Line 1: Line 1:
{{Command|Comments=
{{Command


| arma1 |Game name=
| arma1


|1.00|Game version=
|1.00


|gr1= Program Flow |GROUP1=
|gr1= Program Flow


| Check if a script is finished running using the [[Script_(Handle)]] returned by [[execVM]] or [[spawn]]. |DESCRIPTION=
| Check if a script is finished running using the [[Script_(Handle)]] returned by [[execVM]] or [[spawn]].


| '''scriptDone''' handle |SYNTAX=
| '''scriptDone''' handle


|p1= handle: [[Script (Handle)]] - handle returned by [[spawn]] or [[execVM]] |PARAMETER1=
|p1= handle: [[Script (Handle)]] - handle returned by [[spawn]] or [[execVM]]


| [[Boolean]] |RETURNVALUE=
| [[Boolean]]


|x1= SQS Syntax:<code>@[[scriptDone]] _Handle</code> |EXAMPLE1=
|x1= SQS Syntax:<code>@[[scriptDone]] _Handle</code>


|x2= SQF Syntax:<code>script_handler = [parameters] [[execVM]] "scriptname.sqf";
|x2= SQF Syntax:<code>script_handler = [parameters] [[execVM]] "scriptname.sqf";
[[waitUntil]] { [[scriptDone]] script_handler };</code> |EXAMPLE2=
[[waitUntil]] { [[scriptDone]] script_handler };</code>


| [[execVM]], [[spawn]], [[terminate]], [[scriptNull]]|SEEALSO=
| [[execVM]], [[spawn]], [[terminate]], [[scriptNull]]


}}
}}

Revision as of 12:03, 18 January 2021

Hover & click on the images for description

Description

Description:
Check if a script is finished running using the Script_(Handle) returned by execVM or spawn.
Groups:
Program Flow

Syntax

Syntax:
scriptDone handle
Parameters:
handle: Script (Handle) - handle returned by spawn or execVM
Return Value:
Boolean

Examples

Example 1:
SQS Syntax:@scriptDone _Handle
Example 2:
SQF Syntax:script_handler = [parameters] execVM "scriptname.sqf"; waitUntil { scriptDone script_handler };

Additional Information

See also:
execVMspawnterminatescriptNull

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 03:54, 11 September 2009
Bn880
A Null Script handle can be created in this manner: _handle = 0 spawn {}; That is what any Script_(Handle) becomes when a script is finished running, meaning it will test as true with: scriptDone _handle and it returns "<NULL-script>" when converted to string. This in turn lets you initialize the variable with a completed Script_(Handle) and lets you test the variable even though nothing else may have set the handle by creating a script with spawn or execVM. It also lets you store and manage script handles in arrays, and a few other sexy things.