scriptDone: Difference between revisions
Jump to navigation
Jump to search
Lou Montana (talk | contribs) m (Text replacement - "\[\[Category:[ _]?Scripting[ _]Commands[ _]OFP[ _]Elite(\|.*)?\]\]" to "{{GameCategory|ofpe|Scripting Commands}}") |
Lou Montana (talk | contribs) m (Text replacement - "_{10,} " to "") |
||
| Line 1: | Line 1: | ||
{{Command|Comments= | {{Command|Comments= | ||
| arma1 |Game name= | | arma1 |Game name= | ||
| Line 7: | Line 6: | ||
|gr1= Program Flow |GROUP1= | |gr1= Program Flow |GROUP1= | ||
| 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]]. |DESCRIPTION= | ||
| '''scriptDone''' handle |SYNTAX= | | '''scriptDone''' handle |SYNTAX= | ||
| Line 17: | Line 14: | ||
| [[Boolean]] |RETURNVALUE= | | [[Boolean]] |RETURNVALUE= | ||
|x1= SQS Syntax:<code>@[[scriptDone]] _Handle</code> |EXAMPLE1= | |x1= SQS Syntax:<code>@[[scriptDone]] _Handle</code> |EXAMPLE1= | ||
|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> |EXAMPLE2= | ||
| [[execVM]], [[spawn]], [[terminate]], [[scriptNull]]|SEEALSO= | | [[execVM]], [[spawn]], [[terminate]], [[scriptNull]]|SEEALSO= | ||
Revision as of 02:19, 17 January 2021
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 _handleand 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
Categories:
- Scripting Commands
- Introduced with Armed Assault version 1.00
- ArmA: Armed Assault: New Scripting Commands
- ArmA: Armed Assault: Scripting Commands
- Command Group: Program Flow
- Operation Flashpoint: Elite: Scripting Commands
- Arma 2: Scripting Commands
- Arma 3: Scripting Commands
- Take On Helicopters: Scripting Commands