exec: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
No edit summary
m (Text replacement - "|Game name=" to "|Game name= |gr1= Program Flow |GROUP1= ")
(21 intermediate revisions by 10 users not shown)
Line 1: Line 1:
{{Command|= Comments
{{Command|Comments=
____________________________________________________________________________________________
____________________________________________________________________________________________


| ofp |= Game name
| ofp |Game name=


|1.00|= Game version
|gr1= Program Flow |GROUP1=


|arg= global |= Arguments in MP


|eff= local |= Effects in MP
 
|1.00|Game version=
____________________________________________________________________________________________
____________________________________________________________________________________________


| Execute a script. The argument is passed to the script in the "_this" variable. Learn more about scripts under [[Script|Scripts]]. |= Description
| Execute a script using (the deprecated but still available) [[SQS syntax]]. [[SQF syntax]] (and [[execVM]]) is the most recent scripting language.<br>
The magic variable [[Magic_Variables#time|_time]] used within the script contains the elapsed time in seconds since the script started.
{{Informative | To see the active SQS scripts currently in the scheduler, use [[diag_activeSQSScripts]] command.}} |DESCRIPTION=
____________________________________________________________________________________________
____________________________________________________________________________________________


| argument '''exec''' script |= Syntax
| argument [[exec]] script |SYNTAX=


|p1= argument: [[Any Value]] - the argument which should be passed to the script. To pass multiple arguments, use an array. |= Parameter 1
|p1= argument: [[Any Value]] - the argument passed to the script through the [[Magic_Variables#this|_this]] variable. To pass multiple arguments, use an [[Array]]. |PARAMETER1=


|p2= script: [[String]] - the name of the script. It should be given relatively to the mission folder, campaign scripts subfolder or global scripts folder and is searched there in the same order. <br>If you refer to a script packed together with an addon, the path should look like this: "\ADDON_PBO_NAME\script.sqs" where ADDON_PBO_NAME is the name of the addon's *.pbo file without extension. |= Parameter 2
|p2= script: [[String]] - the file path to the script. It should be given relatively to the mission folder, campaign scripts subfolder or global scripts folder and is searched there in the same order.<br>If you refer to a script packed together with an addon, the path should look like this: "\ADDON_PBO_NAME\script.sqs" where ADDON_PBO_NAME is the name of the addon's [[PBO]] file without extension. |PARAMETER2=


| [[Nothing]] |= Return value
| [[Nothing]] |RETURNVALUE=
____________________________________________________________________________________________
____________________________________________________________________________________________
   
   
|x1= <pre>[player, _jeep] exec "getin.sqs"</pre> |= Example 1
|x1= <code>[<nowiki/>[[player]], _jeep] [[exec]] "getin.sqs"</code> |EXAMPLE1=
____________________________________________________________________________________________
____________________________________________________________________________________________


| [[execVM]], [[call]] |= See also
| [[execVM]], [[call]], [[spawn]], [[execFSM]] |SEEALSO=
 
}}
}}
<h3 style="display:none">Notes</h3>
<dl class="command_description">
<!-- Note Section BEGIN -->
VBS2 VTK: To execute a script with no arguments that will run during the start of a mission, add this to the
initialization line of one of your objects:
[ ] exec "script_name.sqs"
I had some trouble getting this to work at first; the key is to have a space between the brackets.
IMPORTANT: not reccomended for use with .sqf scripts! line breaks will cause problems if you do - use execVM for those
<!-- Note Section END -->
</dl>


<h3 style="display:none">Bottom Section</h3>
<h3 style="display:none">Bottom Section</h3>


[[Category:Scripting Commands|EXEC]]
[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands OFP 1.96|EXEC]]
[[Category:Scripting Commands OFP 1.46|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands OFP 1.46|EXEC]]
[[Category:Scripting Commands OFP 1.96|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands ArmA|EXEC]]
[[Category:Scripting Commands OFP 1.99|{{uc:{{PAGENAME}}}}]]
[[Category:Command Group: Program Flow|EXEC]]
[[Category:Scripting Commands Armed Assault|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands ArmA2|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands Arma 2|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands VBS2|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting_Commands Take On Helicopters|{{uc:{{PAGENAME}}}}]]

Revision as of 11:37, 18 September 2020

Hover & click on the images for description

Description

Description:
Execute a script using (the deprecated but still available) SQS syntax. SQF syntax (and execVM) is the most recent scripting language.
The magic variable _time used within the script contains the elapsed time in seconds since the script started.
To see the active SQS scripts currently in the scheduler, use diag_activeSQSScripts command.
Groups:
Program Flow

Syntax

Syntax:
argument exec script
Parameters:
argument: Any Value - the argument passed to the script through the _this variable. To pass multiple arguments, use an Array.
script: String - the file path to the script. It should be given relatively to the mission folder, campaign scripts subfolder or global scripts folder and is searched there in the same order.
If you refer to a script packed together with an addon, the path should look like this: "\ADDON_PBO_NAME\script.sqs" where ADDON_PBO_NAME is the name of the addon's PBO file without extension.
Return Value:
Nothing

Examples

Example 1:
[player, _jeep] exec "getin.sqs"

Additional Information

See also:
execVMcallspawnexecFSM

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

Bottom Section