terminate: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "| arma |" to "| arma1 |")
m (Text replacement - "since= Arma3" to "since= arma3")
 
(37 intermediate revisions by 5 users not shown)
Line 1: Line 1:
{{Command|Comments=
{{RV|type=command
____________________________________________________________________________________________


| arma1 |Game name=
|game1= ofpe
|version1= 1.00


|gr1= Program Flow |GROUP1=
|game2= arma1
|version2= 1.00


|1.00|Game version=
|game3= arma2
____________________________________________________________________________________________
|version3= 1.00


| Terminates (aborts) [[spawn]]ed or [[execVM]]ed script.
|game4= arma2oa
{{Important | The given script will not terminate immediately upon [[terminate]] command execution, it will do so the next time the script is processed by the [[Scheduler|scheduler]]}}|DESCRIPTION=
|version4= 1.50
____________________________________________________________________________________________


| '''terminate''' scriptHandle |SYNTAX=
|game5= tkoh
|version5= 1.00


|p1= scriptHandle: [[Script]]  |PARAMETER1=  
|game6= arma3
|version6= 0.50


| [[Nothing]] |RETURNVALUE=
|gr1= Program Flow


|x1 = <code>_script = [] [[execVM]] "script.sqf";
|descr= Terminates (aborts) [[spawn]]ed or [[execVM]]ed script.
[[sleep]] 5;
{{Feature | important | The given script will not terminate immediately upon [[terminate]] command execution, it will do so the next time the script is processed by the [[Scheduler|scheduler]]}}
[[terminate]] _script;</code>


|s1= [[terminate]] scriptHandle


| [[execVM]], [[spawn]], [[scriptDone]], [[halt]] |SEEALSO=
|p1= scriptHandle: [[Script Handle]]


}}
|r1= [[Nothing]]
 
 
|s2= [[terminate]] FSMHandle
|s2since= arma3 2.18
 
|p21= FSMHandle: [[Number]] - The FSM script must be launched with 'allowTermination' flag for this command to work (see [[execFSM]]).


<h3 style="display:none">Notes</h3>
|r2= [[Nothing]]
<dl class="command_description">
<!-- Note Section BEGIN -->


<!-- Note Section END -->
|x1= <sqf>_script = [] execVM "script.sqf";
</dl>
sleep 5;
terminate _script;</sqf>  


<h3 style="display:none">Bottom Section</h3>
|seealso= [[execVM]] [[spawn]] [[scriptDone]] [[halt]] [[execFSM]]
[[Category:Scripting Commands|TERMINATE]]
}}
[[Category:Scripting Commands OFP Elite |TERMINATE]]
[[Category:Scripting Commands Armed Assault|TERMINATE]]
[[Category:Scripting Commands Arma 2|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands Take On Helicopters|{{uc:{{PAGENAME}}}}]]

Latest revision as of 17:26, 9 February 2024

Hover & click on the images for description

Description

Description:
Terminates (aborts) spawned or execVMed script.
The given script will not terminate immediately upon terminate command execution, it will do so the next time the script is processed by the scheduler
Groups:
Program Flow

Syntax

Syntax:
terminate scriptHandle
Parameters:
scriptHandle: Script Handle
Return Value:
Nothing

Alternative Syntax

Syntax:
terminate FSMHandle
Parameters:
FSMHandle: Number - The FSM script must be launched with 'allowTermination' flag for this command to work (see execFSM).
Return Value:
Nothing

Examples

Example 1:
_script = [] execVM "script.sqf"; sleep 5; terminate _script;

Additional Information

See also:
execVM spawn scriptDone halt execFSM

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