scriptDone: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Format note and examples)
Line 16: Line 16:
| [[Boolean]] |= Return value
| [[Boolean]] |= Return value
____________________________________________________________________________________________
____________________________________________________________________________________________
|x1=@ScriptDone _Handle


|x2= <code>script_handler <nowiki>=</nowiki> [parameters] execVM "scriptname.sqf";
|x1= SQS Syntax:<code>@[[scriptDone]] _Handle</code> |= Example 1
waitUntil {scriptDone script_handler};</code> |= Example 2
____________________________________________________________________________________________
____________________________________________________________________________________________
|x2= SQF Syntax:<code>script_handler = [parameters] [[execVM]] "scriptname.sqf";
[[waitUntil]] { [[scriptDone]] script_handler };</code> |= Example 2
____________________________________________________________________________________________
| [[execVM]], [[terminate]] |= See also
| [[execVM]], [[terminate]] |= See also


Line 28: Line 31:
<dl class="command_description">
<dl class="command_description">
<!-- Note Section BEGIN -->
<!-- Note Section BEGIN -->
A Null Script handle can be created in this manner:
<dd class="notedate">Posted: 03:54, 11 September 2009</dd>
<dt class="note">[[User:Bn880|Bn880]]</dt>
<dd class="note">A Null Script handle can be created in this manner:
<code>_handle = 0 spawn {};</code>
<code>_handle = 0 spawn {};</code>
That is what any [[Script_(Handle)]] becomes when a script is finished running, meaning it will test as [[true]] with: <code> scriptDone _handle </code> 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.
That is what any [[Script_(Handle)]] becomes when a script is finished running, meaning it will test as [[true]] with: <code> scriptDone _handle </code> 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.</dd>


<!-- Note Section END -->
<!-- Note Section END -->

Revision as of 23:45, 15 June 2014

-wrong parameter ("Arma") defined!-1.00
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:
Uncategorised

Syntax

Syntax:
scriptDone handle
Parameters:
handle: Script_(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:
execVMterminate

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

Bottom Section