scriptDone: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "<!-- Note Section [A-Z]+ --> " to "")
m (Text replacement - "\|( *\[\[[a-zA-Z]+\]\]) * \|x1=" to "|r1=$1 |x1=")
Line 13: Line 13:
|p1= handle: [[Script (Handle)]] - handle returned by [[spawn]] or [[execVM]]
|p1= handle: [[Script (Handle)]] - handle returned by [[spawn]] or [[execVM]]


| [[Boolean]]
|r1= [[Boolean]]


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

Revision as of 15:19, 10 June 2021

Hover & click on the images for description

Description

Description:
Description needed
Groups:
Program Flow

Syntax

Syntax:
Syntax needed
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
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.