Difference between revisions of "deleteVehicle"

From Bohemia Interactive Community
Jump to navigation Jump to search
m
m (Text replacement - "\[\[Category:Scripting Commands OFP 1.[4-9]{2}(\|(\{\{uc:\{\{PAGENAME\}\}\}\}|#|[A-Z]+))?\]\] " to "")
 
(62 intermediate revisions by 21 users not shown)
Line 1: Line 1:
{{Command|= Comments
+
{{RV|type=command
____________________________________________________________________________________________
 
  
| ofp |= Game name
+
| ofp
  
|1.34|= Game version
+
|1.34
  
|arg= global |= Arguments in MP
+
|arg= global
  
|eff= global |= Effects in MP
+
|eff= global
____________________________________________________________________________________________
 
  
| Delete an object. Note that only units inserted in the mission editor and units created during the game's progress can be deleted by this command. Island objects and player units can't be removed. |= Description
+
|gr1= Object Manipulation
____________________________________________________________________________________________
 
  
| '''deleteVehicle''' object |= Syntax
+
| 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>
 +
{{Feature | 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>
 +
{{Feature | 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}}
  
|p1= object: [[Object]] |= Parameter 1
+
| '''deleteVehicle''' object
  
| [[Nothing]] |= Return value
+
|p1=  object: [[Object]]
____________________________________________________________________________________________
+
 
 +
| [[Nothing]]
 
   
 
   
|x1= <pre>deleteVehicle tank</pre>
+
|x1= <code>[[deleteVehicle]] _house1;</code>
 
+
|x2= Deleting a vehicle with crew: <code>// might want to make sure that the car is local
Attention Deleting a vehicle, which is still being accessed by a running script, can cause in a CTD. |= Example 1
+
{car [[deleteVehicleCrew]] _x} [[forEach]] [[crew]] car;
____________________________________________________________________________________________
+
[[deleteVehicle]] car;</code>
  
| [[createVehicle]], [[createUnit]] |= See also
+
| [[createUnit]], [[createVehicleLocal]], [[createVehicle]], [[Arma_3:_Event_Handlers#Deleted | Deleted EH]]
  
 +
|mp=
 
}}
 
}}
  
<h3 style="display:none">Notes</h3>
 
<dl class="command_description">
 
<!-- Note Section BEGIN -->
 
 
<!-- Note Section END -->
 
</dl>
 
 
<h3 style="display:none">Bottom Section</h3>
 
Old Notes (temporary):
 
  
If you run deleteVehicle for every playable soldier, the AI units will be removed. deleteVehicle unit1 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 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"}
 
  
[[Category:Scripting Commands|DELETEVEHICLE]]
+
{{GameCategory|arma1|Scripting Commands}}
[[Category:Scripting Commands OFP 1.96|DELETEVEHICLE]]
+
{{GameCategory|arma2|Scripting Commands}}
[[Category:Scripting Commands OFP 1.46|DELETEVEHICLE]]
+
{{GameCategory|arma3|Scripting Commands}}
[[Category:Scripting Commands ArmA|DELETEVEHICLE]]
+
{{GameCategory|tkoh|Scripting Commands}}

Latest revision as of 00:27, 25 March 2021

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

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