doStop: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "<h3 style="display:none">Bottom Section</h3> " to "")
m (Some wiki formatting)
 
(34 intermediate revisions by 2 users not shown)
Line 1: Line 1:
----
{{RV|type=command
{{Command


| ofp
|game1= ofp
|version1= 1.00


|1.00
|game2= ofpe
|version2= 1.00
 
|game3= arma1
|version3= 1.00
 
|game4= arma2
|version4= 1.00
 
|game5= arma2oa
|version5= 1.50
 
|game6= tkoh
|version6= 1.00
 
|game7= arma3
|version7= 0.50


|arg= global
|arg= global
Line 12: Line 28:
|gr1= Unit Control
|gr1= Unit Control


| Order the given unit(s) to stop (without radio messages). The units stopped in this way will leave the groups formation. It will prevent them from moving around with their group (or formation leader), while still being able to turn around and even move to a new position if they see fit. <br><br>The units will still respond to orders from their group leader (like engage, rearm, board a vehicle), but all of their actions will be separate from the group formation. To resume group default behaviour, use [[doFollow]] command. For example: <tt>[[units]] _group [[doFollow]] [[leader]] _group;</tt>
|descr= Order the given unit(s) to stop (without radio messages). The units stopped in this way will leave the groups formation. It will prevent them from moving around with their group (or formation leader), while still being able to turn around and even move to a new position if they see fit. <br><br>The units will still respond to orders from their group leader (like engage, rearm, board a vehicle), but all of their actions will be separate from the group formation. To resume group default behaviour, use [[doFollow]] command. For example: <sqf inline>units _group doFollow leader _group;</sqf>


| '''doStop''' unit(s)
|s1= [[doStop]] unit(s)


|p1= unit(s): [[Object]] or [[Array]] of [[Object]]s
|p1= unit(s): [[Object]] or [[Array]] of [[Object]]s


| [[Nothing]]
|r1= [[Nothing]]
 
|x1= <code>[[doStop]] _soldier1;</code>


|x2= <code>[[doStop]] [_soldier1, _soldier2];</code>
|x1= <sqf>doStop _soldier1;</sqf>


|x3= <code>[[doStop]] ([[units]] [[player]]);</code>
|x2= <sqf>doStop [_soldier1, _soldier2];</sqf>


| [[commandStop]], [[stop]], [[stopped]], [[doMove]]
|x3= <sqf>doStop (units player);</sqf>


|seealso= [[commandStop]] [[stop]] [[stopped]] [[doMove]] [[doFollow]]
}}
}}


<h3 style="display:none">Notes</h3>
{{Note
<dl class="command_description">
|user= Hardrock
<!-- Note Section BEGIN -->
|timestamp= 20060803143200
 
|text= ''Notes from before the conversion:''
<dd class="notedate">Posted on August 3, 2006 - 14:32
<dt class="note">[[User:Hardrock|hardrock]]<dd class="note">''Notes from before the conversion:''


This command will make the unit stop where he is until the unit's group engages the enemy. At that time, the unit will move and fight the enemy. One good use for this is to place a bunch of units in the same group around a campfire or in some other place "for looks", and make them sit down or have their weapon on their back. When the enemy is spotted, they will get up and attack. Note that you cannot do something like place somebody behind sandbags and keep him there during a fight with this command. For that you will need [[disableAI]] "move".
This command will make the unit stop where he is until the unit's group engages the enemy. At that time, the unit will move and fight the enemy. One good use for this is to place a bunch of units in the same group around a campfire or in some other place "for looks", and make them sit down or have their weapon on their back. When the enemy is spotted, they will get up and attack. Note that you cannot do something like place somebody behind sandbags and keep him there during a fight with this command. For that you will need [[disableAI]] "move".
}}


<dd class="notedate">
{{Note
<dt class="note">[[User:Ceeeb|Ceeeb]]
|user= Ceeeb
<dd class="note">In '''ArmA 1.14''', this command will not stop a unit that has been given a move order by selecting the unit, then clicking on the in game map (or ground).
|timestamp= 20090221001300
|text= In '''ArmA 1.14''', this command will not stop a unit that has been given a move order by selecting the unit, then clicking on the in game map (or ground).
}}


<dd class="notedate">
{{Note
<dt class="note">[[User:Katulobotomia|Katulobotomia]]
|user= Katulobotomia
<dd class="note">doStop'ed units WILL return to formation if their leader's behaviour isn't set to "COMBAT". The squad leader will also order everyone to return to formation if there are no enemies nearby in a set period of time, overwriting the doStop command. doStop can be best used to simply stop the unit from doing whatever he is currently doing without radio messages.
|timestamp= 20130926123000
|text= doStop'ed units WILL return to formation if their leader's behaviour isn't set to "COMBAT". The squad leader will also order everyone to return to formation if there are no enemies nearby in a set period of time, overwriting the doStop command. doStop can be best used to simply stop the unit from doing whatever he is currently doing without radio messages.
}}


<!-- Note Section END -->
{{Note
</dl>
|user= Killzone_Kid
|timestamp= 20161223212200
|text= When a unit reaches position given with [[doMove]], [[unitReady]] becomes [[true]]. If [[doStop]] command is not executed, unit will start wondering on its own soon after, especially if unit is under fire. [[doStop]] will keep unit at the given position, but watch out for [[unitReady]] as it will become [[false]] since unit is holding position indefinitely.
}}


 
{{Note
 
|user= Killzone_Kid
[[Category:Scripting Commands|DOSTOP]]
|timestamp= 20161227003000
[[Category:Scripting Commands OFP 1.99|DOSTOP]]
|text= Although it is possible to resume group default behaviour by joining units into own group like this {{hl|units _group joinSilent _group}} there is a risk that the leader will change. Instead use [[doFollow]] command as explained in the description.
[[Category:Scripting Commands OFP 1.96|DOSTOP]]
}}
[[Category:Scripting Commands OFP 1.46|DOSTOP]]
{{GameCategory|arma1|Scripting Commands}}
{{GameCategory|arma2|Scripting Commands}}
{{GameCategory|arma3|Scripting Commands}}
{{GameCategory|tkoh|Scripting Commands}}
 
<!-- CONTINUE Notes -->
<dl class="command_description">
<dd class="notedate">Posted on December 23, 2016 - 21:22 (UTC)</dd>
<dt class="note">[[User:Killzone Kid|Killzone Kid]]</dt>
<dd class="note"> When a unit reaches position given with [[doMove]], [[unitReady]] becomes [[true]]. If [[doStop]] command is not executed, unit will start wondering on its own soon after, especially if unit is under fire. [[doStop]] will keep unit at the given position, but watch out for [[unitReady]] as it will become [[false]] since unit is holding position indefinitely.
</dd>
</dl>
<!-- DISCONTINUE Notes -->
 
<!-- CONTINUE Notes -->
<dl class="command_description">
<dd class="notedate">Posted on December 27, 2016 - 00:30 (UTC)</dd>
<dt class="note">[[User:Killzone Kid|Killzone Kid]]</dt>
<dd class="note">
Although it is possible to resume group default behaviour by joining units into own group like this <tt>units _group joinSilent _group</tt> there is a risk that the leader will change. Instead use [[doFollow]] command as explained in the description.
</dd>
</dl>
<!-- DISCONTINUE Notes -->

Latest revision as of 21:43, 14 December 2022

Hover & click on the images for description

Description

Description:
Order the given unit(s) to stop (without radio messages). The units stopped in this way will leave the groups formation. It will prevent them from moving around with their group (or formation leader), while still being able to turn around and even move to a new position if they see fit.

The units will still respond to orders from their group leader (like engage, rearm, board a vehicle), but all of their actions will be separate from the group formation. To resume group default behaviour, use doFollow command. For example: units _group doFollow leader _group;
Groups:
Unit Control

Syntax

Syntax:
doStop unit(s)
Parameters:
unit(s): Object or Array of Objects
Return Value:
Nothing

Examples

Example 1:
doStop _soldier1;
Example 2:
doStop [_soldier1, _soldier2];
Example 3:
doStop (units player);

Additional Information

See also:
commandStop stop stopped doMove doFollow

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
Hardrock - c
Posted on Aug 03, 2006 - 14:32 (UTC)
Notes from before the conversion: This command will make the unit stop where he is until the unit's group engages the enemy. At that time, the unit will move and fight the enemy. One good use for this is to place a bunch of units in the same group around a campfire or in some other place "for looks", and make them sit down or have their weapon on their back. When the enemy is spotted, they will get up and attack. Note that you cannot do something like place somebody behind sandbags and keep him there during a fight with this command. For that you will need disableAI "move".
Ceeeb - c
Posted on Feb 21, 2009 - 00:13 (UTC)
In ArmA 1.14, this command will not stop a unit that has been given a move order by selecting the unit, then clicking on the in game map (or ground).
Katulobotomia - c
Posted on Sep 26, 2013 - 12:30 (UTC)
doStop'ed units WILL return to formation if their leader's behaviour isn't set to "COMBAT". The squad leader will also order everyone to return to formation if there are no enemies nearby in a set period of time, overwriting the doStop command. doStop can be best used to simply stop the unit from doing whatever he is currently doing without radio messages.
Killzone_Kid - c
Posted on Dec 23, 2016 - 21:22 (UTC)
When a unit reaches position given with doMove, unitReady becomes true. If doStop command is not executed, unit will start wondering on its own soon after, especially if unit is under fire. doStop will keep unit at the given position, but watch out for unitReady as it will become false since unit is holding position indefinitely.
Killzone_Kid - c
Posted on Dec 27, 2016 - 00:30 (UTC)
Although it is possible to resume group default behaviour by joining units into own group like this units _group joinSilent _group there is a risk that the leader will change. Instead use doFollow command as explained in the description.