Difference between revisions of "deleteVehicle"

From Bohemia Interactive Community
Jump to navigation Jump to search
m
m (Text replacement - "\[\[Category\: ?Command[ _]Group\:.*\|\{\{uc\:\{\{PAGENAME\}\}\}\}\]\] " to "")
 
(44 intermediate revisions by 21 users not shown)
Line 1: Line 1:
[[Category:Scripting Commands|DELETEVEHICLE]]
+
{{Command|Comments=
[[Category:Scripting Commands OFP 1.96|DELETEVEHICLE]]
+
____________________________________________________________________________________________
[[Category:Scripting Commands OFP 1.46|DELETEVEHICLE]]
 
[[Category:Scripting Commands ArmA|DELETEVEHICLE]]
 
  
 +
| ofp |Game name=
  
<h2 style="color:#000066">'''deleteVehicle ''object'''''</h2>
+
|1.34|Game version=
  
 +
|arg= global |Multiplayer Arguments=
  
'''Operand types:'''
+
|eff= global |Multiplayer Effects=
  
'''object:''' [[Object]]
+
|gr1= Object Manipulation |GROUP1=
 +
____________________________________________________________________________________________
  
'''Type of returned value:'''
+
| Deletes an object. Only objects inserted in the mission editor and objects created during the game's progress can be deleted by this command. Island objects and player cannot be removed.<br><br>
 +
{{Informative | The actual object deletion, when object becomes [[objNull]], happens on the next frame after command execution, but there are some object modifications that happen immediately. For example if the object is unit in a group, it immediately becomes groupless <tt>[[isNull]] [[group]] _unit; //true</tt>}}<br>
 +
{{warning | Do not use this command for deletion of dead [[crew]] members from a vehicle. Doing so may lead to all sorts of bugs and ghost objects left on the map. Instead use [[deleteVehicleCrew]], which was designed with this functionality in mind}} |DESCRIPTION=
 +
____________________________________________________________________________________________
  
[[Nothing]]
+
| '''deleteVehicle''' object |SYNTAX=
  
'''Compatibility:'''
+
|p1=  object: [[Object]] |PARAMETER1=
  
Added in version '''1.34'''
+
| [[Nothing]] |RETURNVALUE=
 +
____________________________________________________________________________________________
 +
 
 +
|x1= <code>[[deleteVehicle]] _house1;</code> |EXAMPLE1=
 +
|x2= Deleting a vehicle with crew: <code>// might want to make sure that the car is local
 +
{car [[deleteVehicleCrew]] _x} [[forEach]] [[crew]] car;
 +
[[deleteVehicle]] car;</code>|EXAMPLE2=
 +
____________________________________________________________________________________________
  
'''Description:'''
+
| [[createUnit]], [[createVehicleLocal]], [[createVehicle]], [[Arma_3:_Event_Handlers#Deleted | Deleted EH]] |SEEALSO=
  
Delete any unit or vehicle.
+
|mp= |=
  
Only vehicles inserted in editor or created during mission can be deleted.
+
}}
  
Player unit cannot be deleted.
+
<h3 style="display:none">Notes</h3>
 +
<dl class="command_description">
 +
<!-- Note Section BEGIN -->
  
 +
<!-- Note Section END -->
 +
</dl>
  
'''Example:'''
+
<h3 style="display:none">Bottom Section</h3>
  
'''deleteVehicle''' tankOne
 
  
 
+
[[Category:Scripting Commands|DELETEVEHICLE]]
'''Comments:'''
+
[[Category:Scripting Commands OFP 1.99|DELETEVEHICLE]]
 
+
[[Category:Scripting Commands OFP 1.96|DELETEVEHICLE]]
*Since this function will not delete a player unit, a useful multiplayer application is the removal of AI created by players leaving the game.
+
[[Category:Scripting Commands OFP 1.46|DELETEVEHICLE]]
 
+
[[Category:Scripting Commands Armed Assault|DELETEVEHICLE]]
If you run '''deleteVehicle''' for every playable soldier, the AI units will be removed.
+
[[Category:Scripting Commands Arma 2|{{uc:{{PAGENAME}}}}]]
 
+
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
*If ''unit1'' is a living unit that is currently located inside a vehicle then:
+
[[Category:Scripting Commands Take On Helicopters|{{uc:{{PAGENAME}}}}]]
'''deleteVehicle''' ''unit1''
+
[[Category:Command_Group:_Object_Manipulation|{{uc:{{PAGENAME}}}}]]
will result in some very strange, and unwelcome, things happening.
 
 
 
A safer way to delete ''unit1'' if it is, or might be, inside a vehicle is:
 
 
 
 
 
[[unassignVehicle]] ''unit1''
 
 
 
''unit1'' [[setPos]] [0,0,0]
 
 
 
'''deleteVehicle''' ''unit1''
 
 
 
 
 
*You need have no concern over attempting to access deleted units in subsequent scripts.
 
 
 
The line below works just fine for units that have been deleted.
 
 
 
[[if]] ([[alive]] ''unit1'') [[then]] {[[hint]]"He is alive"} [[else]] {[[hint]]"Oh no he's not"}
 

Latest revision as of 15:07, 24 September 2020

Introduced with Operation Flashpoint version 1.341.34Arguments of this scripting command don't have to be local to the client the command is executed onEffects of this scripting command are broadcasted over the network and happen on every computer in the network
Hover & click on the images for descriptions

Description

Description:
Deletes an object. Only objects inserted in the mission editor and objects created during the game's progress can be deleted by this command. Island objects and player cannot be removed.

The actual object deletion, when object becomes objNull, happens on the next frame after command execution, but there are some object modifications that happen immediately. For example if the object is unit in a group, it immediately becomes groupless isNull group _unit; //true

Do not use this command for deletion of dead crew members from a vehicle. Doing so may lead to all sorts of bugs and ghost objects left on the map. Instead use deleteVehicleCrew, which was designed with this functionality in mind

Syntax

Syntax:
deleteVehicle object
Parameters:
object: Object
Return Value:
Nothing

Examples

Example 1:
deleteVehicle _house1;
Example 2:
Deleting a vehicle with crew: // might want to make sure that the car is local {car deleteVehicleCrew _x} forEach crew car; deleteVehicle car;

Additional Information

See also:
createUnitcreateVehicleLocalcreateVehicle Deleted EH
Groups:
Object Manipulation

Notes

i
Only post proven facts here. Report bugs on the Feedback Tracker and discuss on the Arma Discord or on the Forums.

Notes

Bottom Section