deleteVehicle: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
mNo edit summary
m (2.16 -> 2.18)
 
(88 intermediate revisions by 18 users not shown)
Line 1: Line 1:
{{Command|= Comments
{{RV|type=command
____________________________________________________________________________________________


| ofp |= Game name
|game1= ofp
|version1= 1.34


|1.34|= Game version
|game2= ofpe
|version2= 1.00


|arg= global |= Arguments in MP
|game3= arma1
|version3= 1.00


|eff= global |= Effects in MP
|game4= arma2
____________________________________________________________________________________________
|version4= 1.00


| 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
|game5= arma2oa
____________________________________________________________________________________________
|version5= 1.50


| '''deleteVehicle''' object |= Syntax
|game6= tkoh
|version6= 1.00


|p1= object: [[Object]] |= Parameter 1
|game7= arma3
|version7= 0.50


| [[Nothing]] |= Return value
|arg= global
____________________________________________________________________________________________
 
|x1= <pre>deleteVehicle tank</pre>


Attention Deleting a vehicle, which is still being accessed by a running script, can result in a CTD. |= Example 1
|eff= global
____________________________________________________________________________________________


| [[createUnit]], [[createUnit array]], [[createVehicle array]], [[createVehicleLocal]], [[createVehicle]] |= See also
|gr1= Object Manipulation


}}
|descr= Deletes an object. Only objects inserted in the mission editor and objects created during the game's progress can be deleted by this command. Terrain objects and players cannot be deleted.
{{Feature|informative|The actual object deletion, when the 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 a unit in a group, it immediately becomes groupless (<sqf inline>isNull group _unit; // true</sqf>).}}


<h3 style="display:none">Notes</h3>
|pr= {{Feature|warning|Use [[deleteVehicleCrew]] to delete units that are in a vehicle! Do '''not''' use this command for a vehicle's [[crew]] members as it may lead to all sorts of bugs and ghost objects left on the map.}}
<dl class="command_description">
<!-- Note Section BEGIN -->


<dd class="notedate">Posted on August 3, 2006 - 14:30</dd>
|s1= [[deleteVehicle]] object
<dt class="note">'''[[User:Hardrock|hardrock]]'''</dt><dd class="note">''Notes from before the conversion:''


If you run deleteVehicle for every playable soldier, the AI units will be removed.
|p1= object: [[Object]]


<code>deleteVehicle unit1</code>
|r1= [[Nothing]]


will result in some very strange, and unwelcome, things happening.  
|s2= [[deleteVehicle]] objects
|s2since= arma3 2.18


A safer way to delete unit1 if it is, or might be, inside a vehicle is:  
|p21= objects: [[Array]] of [[Object]]s


<code>[[unassignVehicle]] unit1<br/>
|r2= [[Nothing]]
unit1 [[setPos]] [0,0,0]<br/>
deleteVehicle unit1</code>


The line below works just fine for units that have been deleted.
|x1= <sqf>deleteVehicle _house1;</sqf>


<code>[[if]] ([[alive]] unit1) [[then]] {[[hint]]"He is alive"} [[else]] {[[hint]]"Oh no he's not"}</code>
|x2= Deleting a vehicle with crew:
</dd>
<sqf>
// might want to make sure that the car is local
{ car deleteVehicleCrew _x } forEach crew car;
deleteVehicle car;
</sqf>


<!-- Note Section END -->
|seealso= [[deleteVehicleCrew]] [[createUnit]] [[createVehicleLocal]] [[createVehicle]] [[Arma_3:_Event_Handlers#Deleted | Deleted EH]]
</dl>
}}
 
<h3 style="display:none">Bottom Section</h3>
 
 
[[Category:Scripting Commands|DELETEVEHICLE]]
[[Category:Scripting Commands OFP 1.96|DELETEVEHICLE]]
[[Category:Scripting Commands OFP 1.46|DELETEVEHICLE]]
[[Category:Scripting Commands ArmA|DELETEVEHICLE]]
[[Category:Command_Group:_Unit_Control|{{uc:{{PAGENAME}}}}]]

Latest revision as of 15:01, 8 February 2024

Logo A0.png1.34ofpe logo.png1.00Logo A1 black.png1.00Logo A2.png1.00A2 OA Logo.png1.50tkoh logo small.png1.00Arma 3 logo black.png0.50
GAGlobalGEGlobal
Hover & click on the images for description

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. Terrain objects and players cannot be deleted.
ⓘ
The actual object deletion, when the 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 a unit in a group, it immediately becomes groupless (isNull group _unit; // true).
Problems:
⚠
Use deleteVehicleCrew to delete units that are in a vehicle! Do not use this command for a vehicle's crew members as it may lead to all sorts of bugs and ghost objects left on the map.
Groups:
Object Manipulation

Syntax

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

Alternative Syntax

Syntax:
deleteVehicle objects
Parameters:
objects: Array of Objects
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:
deleteVehicleCrew createUnit createVehicleLocal createVehicle Deleted EH

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
Retrieved from "https://community.bistudio.com/wiki?title=deleteVehicle&oldid=352346"