terminate: Difference between revisions

From Bohemia Interactive Community
m (Text replacement - " |game1= arma1 |version1= 1.00 |game2= arma2 |version2= 1.00 |game3= arma2oa |version3= 1.50 |game4= tkoh |version4= 1.00 |game5= arma3 |version5= 0.50 " to " |game1= ofpe |version1= 1.00 |game2= arma1 |version2= 1.00 |game3=...)
(Add Promises)
 
(15 intermediate revisions by 4 users not shown)
Line 19: Line 19:
|version6= 0.50
|version6= 0.50


|gr1= Program Flow
|gr1= Program Flow


|descr= Terminates (aborts) [[spawn]]ed or [[execVM]]ed script.
|descr= Terminates (aborts) [[spawn]]ed or [[execVM]]ed script.
{{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]]}}
{{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]]}}


|s1= '''terminate''' scriptHandle
|s1= [[terminate]] scriptHandle


|p1= scriptHandle: [[Script]]
|p1= scriptHandle: [[Script Handle]]


|r1= [[Nothing]]
|r1= [[Nothing]]


|x1= <code>_script = [] [[execVM]] "script.sqf";
[[sleep]] 5;
[[terminate]] _script;</code>


|seealso= [[execVM]], [[spawn]], [[scriptDone]], [[halt]]
|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]]).
 
|r2= [[Nothing]]
 
 
|s3= scriptHandle [[terminate]] result
|s3since= arma3 2.22
|p41= scriptHandle: [[Script Handle]] - Only [[Script_Handle#Promise_Handles|"Empty Handle"]]'s can have their result set.
|p42= result: [[Anything]] - The result to write into the [[Script_Handle#Promise_Handles|Promise]]
 
 
 
|x1= <sqf>
_script = [] execVM "script.sqf";
sleep 5;
terminate _script;
</sqf>
 
|seealso= [[execVM]] [[spawn]] [[scriptDone]] [[halt]] [[execFSM]]
}}
}}
{{GameCategory|ofpe|Scripting Commands}}
{{GameCategory|arma2|Scripting Commands}}
{{GameCategory|arma3|Scripting Commands}}
{{GameCategory|tkoh|Scripting Commands}}

Latest revision as of 17:35, 10 July 2025

ofpe logo.png 1.00Logo A1 black.png 1.00Logo A2.png 1.00A2 OA Logo.png 1.50tkoh logo small.png 1.00Arma 3 logo black.png 0.50
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 1

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

Syntax 2

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

Syntax 3

Syntax:
scriptHandle terminate result
Parameters:
scriptHandle: Script Handle - Only "Empty Handle"'s can have their result set.
result: Anything - The result to write into the Promise
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
Retrieved from "https://community.bistudio.com/wiki?title=terminate&oldid=373976"