execVM: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
(format)
m (template:command argument fix)
(8 intermediate revisions by 2 users not shown)
Line 7: Line 7:
____________________________________________________________________________________________
____________________________________________________________________________________________


| Compile and execute [[SQF_syntax|SQF]] [[Script]]. The optional argument is passed to the script as local variable <tt>_this</tt>.
| Compiles and adds [[SQF_syntax|SQF]] [[Script]] to the [[Scheduler|scheduler]] queue and returns script handle. The script is first searched for in the mission folder, then in the campaign scripts folder and finally in the global scripts folder. The script does not execute immediately upon running [[execVM]] command, but with some delay. How much delay is unknown as it largely depends on how many other scripts there are in the queue and how busy is VM. The optional argument is passed to the script in [[private]] variable <tt>_this</tt>. In Arma 3 the script handle is also passed to the script in <tt>_thisScript</tt> variable.
<br>The [[Script]] is first searched for in the mission folder, then in the campaign scripts folder and finally in the global scripts folder. |= Description
<br><br>In order to understand [[execVM]] consider the following comparison:
<code>[[private]] _handle <nowiki>=</nowiki> _args [[execVM]] "someFile.sqf";
// is practically identical to
[[private]] _handle <nowiki>=</nowiki> _args [[spawn]] [[compile]] [[preprocessFileLineNumbers]] "someFile.sqf";</code>
So if you need multiple execution of the same file, you might want to store it in a function ([[Functions_Library_(Arma_3)|Functions Library]]), otherwise, for a single execution, [[execVM]] is a good choice.<br><br>
 
To see what VM scripts are currently in the scheduler, use [[diag_activeSQFScripts]] command.
|DESCRIPTION=
____________________________________________________________________________________________
____________________________________________________________________________________________


| argument(s) '''execVM''' filename |= Syntax
| arguments '''execVM''' filename |SYNTAX=


|p1= argument(s): [[Any Value]](s) -  Argument(s) accessible as <tt>_this</tt> in the script |= Parameter 1
|p1= arguments: [[Anything]]  -  Arguments accessible as <tt>_this</tt> in the script |PARAMETER1=


|p2= filename: [[String]] - file with sqf code|= Parameter 2
|p2= filename: [[String]] - file with sqf code (doesn't have to have .sqf extension, but not using standard extensions may cause problems later, during binarisation)|PARAMETER2=


| [[Script_(Handle)|Script Handle]] - can be used to determine (via [[scriptDone]] (also via [[isNull]] in Arma 3)) when the execVMed script has finished. In Arma 3, the handle is also available inside the execVMed script in <tt>_thisScript</tt> variable.|= Return value
| [[Script]] - script handle, can be used to determine (via [[scriptDone]] (also via [[isNull]] in Arma 3)) when the execVMed script has finished. In Arma 3, the handle is also available inside the execVMed script in <tt>_thisScript</tt> variable.|RETURNVALUE=


|s2= '''execVM''' filename |= Syntax
|s2= '''execVM''' filename |SYNTAX=


|p21= filename: [[String]] - file with sqf code |= Parameter 2
|p21= filename: [[String]] - file with sqf code (doesn't have to have .sqf extension, but not using standard extensions may cause problems later, during binarisation) |PARAMETER2=


| r2= [[Script_(Handle)|Script Handle]] - can be used to determine (via [[scriptDone]] (also via [[isNull]] in Arma 3)) when the execVMed script has finished. In Arma 3, the handle is also available inside the execVMed script in <tt>_thisScript</tt> variable.|= Return value
| r2= [[Script]] - script handle, can be used to determine (via [[scriptDone]] (also via [[isNull]] in Arma 3)) when the execVMed script has finished. In Arma 3, the handle is also available inside the execVMed script in <tt>_thisScript</tt> variable.|RETURNVALUE=
____________________________________________________________________________________________
____________________________________________________________________________________________
   
   
|x1= <code>_handle = [[execVM]] "test.sqf";</code> |= Example 1
|x1= <code>_handle = [[execVM]] "test.sqf";</code> |EXAMPLE1=


|x2= <code>_handle = [[player]] [[execVM]] "test.sqf";  
|x2= <code>_handle = [[player]] [[execVM]] "test.sqf";  
[[waitUntil]] {[[scriptDone]] _handle};</code> |= Example 2
[[waitUntil]] {[[scriptDone]] _handle};</code> |EXAMPLE2=


|x3= In Arma 3 this is also possible: <code>_handle = [[execVM]] "123.sqf";  
|x3= In Arma 3 this is also possible: <code>_handle = [[execVM]] "123.sqf";  
[[waitUntil]] {[[isNull]] _handle};</code> |= Example 2
[[waitUntil]] {[[isNull]] _handle};</code> |EXAMPLE2=




Line 38: Line 45:
// showDamage.sqf
// showDamage.sqf
_damage = _this [[select]] 0;
_damage = _this [[select]] 0;
[[hint]] [[format]] ["%1", _damage];</code> |= Example 4
[[hint]] [[format]] ["%1", _damage];</code> |EXAMPLE4=
____________________________________________________________________________________________
____________________________________________________________________________________________


| [[call]], [[spawn]], [[exec]], [[execFSM]], [[scriptDone]], [[scriptNull]], [[terminate]], [[sleep]], [[uiSleep]], [[waitUntil]], [[canSuspend]], [[SQF syntax]], [[Control Structures]] |= See also
| [[call]], [[spawn]], [[exec]], [[execFSM]], [[scriptDone]], [[scriptNull]], [[terminate]], [[sleep]], [[uiSleep]], [[waitUntil]], [[canSuspend]], [[diag_activeScripts]], [[diag_activeSQFScripts]], [[SQF syntax]], [[Control Structures]] |SEEALSO=


}}
}}
Line 47: Line 54:
<h3 style="display:none">Notes</h3>
<h3 style="display:none">Notes</h3>
<dl class="command_description">
<dl class="command_description">
<!-- Note Section BEGIN -->
<dd class="notedate">Posted on January 5, 2007 - 12:30
<dt class="note">'''[[User:Giova|Giova]]'''<dd class="note">More about the Returned value:''
the type 'Script' returned by this command, is in fact a kind of 'Thread Handle'.
GOOD POINT:
sqf functions launched with execVM will run asynchronously from its caller script/function.
It is possible to manage multi-threading development, by using:
-handle script returned by execVM
-force the thread to terminate by using 'terminate' command
-synchronise a script by using 'ScriptDone' command
BAD POINT:
-sqf funcion cannot return value (because execVM is already returning the thread Handle)
-the variable _time does not work in sqf called with execVM command
<!-- Note Section END -->
</dl>
</dl>


Revision as of 15:39, 7 April 2019

-wrong parameter ("Arma") defined!-1.00
Hover & click on the images for description

Description

Description:
Compiles and adds SQF Script to the scheduler queue and returns script handle. The script is first searched for in the mission folder, then in the campaign scripts folder and finally in the global scripts folder. The script does not execute immediately upon running execVM command, but with some delay. How much delay is unknown as it largely depends on how many other scripts there are in the queue and how busy is VM. The optional argument is passed to the script in private variable _this. In Arma 3 the script handle is also passed to the script in _thisScript variable.

In order to understand execVM consider the following comparison: private _handle = _args execVM "someFile.sqf"; // is practically identical to private _handle = _args spawn compile preprocessFileLineNumbers "someFile.sqf"; So if you need multiple execution of the same file, you might want to store it in a function (Functions Library), otherwise, for a single execution, execVM is a good choice.

To see what VM scripts are currently in the scheduler, use diag_activeSQFScripts command.
Groups:
Uncategorised

Syntax

Syntax:
arguments execVM filename
Parameters:
arguments: Anything - Arguments accessible as _this in the script
filename: String - file with sqf code (doesn't have to have .sqf extension, but not using standard extensions may cause problems later, during binarisation)
Return Value:
Script - script handle, can be used to determine (via scriptDone (also via isNull in Arma 3)) when the execVMed script has finished. In Arma 3, the handle is also available inside the execVMed script in _thisScript variable.

Alternative Syntax

Syntax:
execVM filename
Parameters:
filename: String - file with sqf code (doesn't have to have .sqf extension, but not using standard extensions may cause problems later, during binarisation)
Return Value:
Script - script handle, can be used to determine (via scriptDone (also via isNull in Arma 3)) when the execVMed script has finished. In Arma 3, the handle is also available inside the execVMed script in _thisScript variable.

Examples

Example 1:
_handle = execVM "test.sqf";
Example 2:
_handle = player execVM "test.sqf"; waitUntil {scriptDone _handle};
Example 3:
In Arma 3 this is also possible: _handle = execVM "123.sqf"; waitUntil {isNull _handle};
Example 4:
[4] execVM "showDamage.sqf"; // showDamage.sqf _damage = _this select 0; hint format ["%1", _damage];

Additional Information

See also:
callspawnexecexecFSMscriptDonescriptNullterminatesleepuiSleepwaitUntilcanSuspenddiag_activeScriptsdiag_activeSQFScriptsSQF syntaxControl Structures

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

Notes

Posted on November 23, 2010 - 15:56
Kabilen
Passing variables to the script file To pass multiple variables to the script file, use an array e.g: null = [myunit,1234] execVM "test.sqf"; Now within test.sqf to access the elements, use the following: _myunit = _this select 0;
_myvar = _this select 1;

Notes

Bottom Section

Retrieved from "https://community.bistudio.com/wiki?title=execVM&oldid=121539"