execVM
Jump to navigation
Jump to search
Description
- Description:
- Compile and execute SQF Script. The optional argument is passed to the script as local variable _this.
The Script is first searched for in the mission folder, then in the campaign scripts folder and finally in the global scripts folder. - Groups:
- Uncategorised
Syntax
- Syntax:
- argument(s) execVM filename
- Parameters:
- argument(s): Any Value(s) - Argument(s) accessible as _this in the script
- filename: String - file with sqf code
- Return Value:
- 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
- Return Value:
- 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:
- callspawnexecexecFSMscriptDonescriptNullterminatesleepuiSleepwaitUntilcanSuspendSQF 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
- Posted on January 5, 2007 - 12:30
- Giova
- 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
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;