doStop: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
No edit summary
 
No edit summary
Line 1: Line 1:
back to [[Scripting_Reference#D|COMREF]]
<h2 style="color:#000066">'''doStop'''</h2>
<h2 style="color:#000066">'''doStop'''</h2>


'''Operand types:'''
'''Operand types:'''
Line 7: Line 10:
'''Type of returned value:'''
'''Type of returned value:'''


Nothing
[[Nothing]]


'''Description:'''
'''Description:'''
Line 13: Line 16:
Order unit to stop (silent).
Order unit to stop (silent).


''Note:'' Stop command is never finished, unit will never be ready.
'''Note:''' Stop command is never finished, unit will never be ready.
 


'''Example:'''
'''Example:'''
Line 19: Line 23:
'''doStop''' unitOne
'''doStop''' unitOne


'''Comments'''
 
'''Comments:'''


This command will make the unit stop where he is until the unit's group engages the enemy.
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.
At that time, the unit will move and fight the enemy.


One good use for this is to place a bunch of guys 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.
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.
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.
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".
For that you will need [[disableAI]] "move".

Revision as of 12:22, 16 April 2006

back to COMREF

doStop


Operand types:

None

Type of returned value:

Nothing

Description:

Order unit to stop (silent).

Note: Stop command is never finished, unit will never be ready.


Example:

doStop unitOne


Comments:

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".