execVM

1.001.001.501.000.50

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.

⚠

If the file you are executing is not prepared using UTF-8 encoding and contains some characters with codes > 127, they might convert incorrectly

Groups:

Program Flow

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 private _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