deleteVehicle: 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">'''deleteVehicle ''object'''''</h2>
<h2 style="color:#000066">'''deleteVehicle ''object'''''</h2>


'''Operand types:'''
'''Operand types:'''


object: [[Object]]
'''object:''' [[Object]]


'''Type of returned value:'''
'''Type of returned value:'''


Nothing
[[Nothing]]


'''Description:'''
'''Description:'''


Delete any unit or vehicle.
Delete any unit or vehicle.
Only vehicles inserted in editor or created during mission can be deleted.
Only vehicles inserted in editor or created during mission can be deleted.
Player unit cannot be deleted.
Player unit cannot be deleted.


'''Example:'''
'''Example:'''


'''deleteVehicle''' tank
'''deleteVehicle''' tankOne
 


'''Comments'''
'''Comments'''


Since this function will not delete a player unit, a useful multiplayer application is the removal of AI created by players leaving the game.
Since this function will not delete a player unit, a useful multiplayer application is the removal of AI created by players leaving the game.
If you run [[deleteVehicle]] for every playable soldier, the AI units will be removed.
If you run [[deleteVehicle]] for every playable soldier, the AI units will be removed.

Revision as of 11:58, 16 April 2006

back to COMREF

deleteVehicle object


Operand types:

object: Object

Type of returned value:

Nothing

Description:

Delete any unit or vehicle.

Only vehicles inserted in editor or created during mission can be deleted.

Player unit cannot be deleted.


Example:

deleteVehicle tankOne


Comments

Since this function will not delete a player unit, a useful multiplayer application is the removal of AI created by players leaving the game.

If you run deleteVehicle for every playable soldier, the AI units will be removed.