deleteVehicle: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
(Updated example to explain that a unit must be outside of a Vehicle first, before calling deleteVehicle.)
m (Text replacement - "_{10,} " to "")
(42 intermediate revisions by 16 users not shown)
Line 1: Line 1:
{{Command|= Comments
{{Command|Comments=
____________________________________________________________________________________________


| ofp |= Game name
| ofp |Game name=


|1.34|= Game version
|1.34|Game version=


|arg= global |= Arguments in MP
|arg= global |Multiplayer Arguments=


|eff= global |= Effects in MP
|eff= global |Multiplayer Effects=
____________________________________________________________________________________________


| 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 |GROUP1=
____________________________________________________________________________________________


| '''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>
{{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=


|p1= object: [[Object]] |= Parameter 1
| '''deleteVehicle''' object |SYNTAX=


| [[Nothing]] |= Return value
|p1=  object: [[Object]] |PARAMETER1=
____________________________________________________________________________________________
 
| [[Nothing]] |RETURNVALUE=
   
   
|x1= <pre>deleteVehicle tank</pre>
|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=


Attention Deleting a vehicle, which is still being accessed by a running script, can result in a CTD. |= Example 1
| [[createUnit]], [[createVehicleLocal]], [[createVehicle]], [[Arma_3:_Event_Handlers#Deleted | Deleted EH]] |SEEALSO=
____________________________________________________________________________________________


| [[createUnit]], [[createUnit array]], [[createVehicle array]], [[createVehicleLocal]], [[createVehicle]] |= See also
|mp= |=


}}
}}
Line 33: Line 35:
<dl class="command_description">
<dl class="command_description">
<!-- Note Section BEGIN -->
<!-- Note Section BEGIN -->
<dd class="notedate">Posted on August 3, 2006 - 14:30</dd>
<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.
<code>deleteVehicle unit1</code>
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:
<code>[[unassignVehicle]] unit1<br/>
unit1 [[setPos]] [0,0,0]<br/>
deleteVehicle unit1</code>
''This is because you cannot call deleteVehicle on a unit (soldier) who's currently inside a Vehicle.''
The line below works just fine for units that have been deleted.
<code>[[if]] ([[alive]] unit1) [[then]] {[[hint]]"He is alive"} [[else]] {[[hint]]"Oh no he's not"}</code>
</dd>


<!-- Note Section END -->
<!-- Note Section END -->
Line 63: Line 43:


[[Category:Scripting Commands|DELETEVEHICLE]]
[[Category:Scripting Commands|DELETEVEHICLE]]
[[Category:Scripting Commands OFP 1.99|DELETEVEHICLE]]
[[Category:Scripting Commands OFP 1.96|DELETEVEHICLE]]
[[Category:Scripting Commands OFP 1.96|DELETEVEHICLE]]
[[Category:Scripting Commands OFP 1.46|DELETEVEHICLE]]
[[Category:Scripting Commands OFP 1.46|DELETEVEHICLE]]
[[Category:Scripting Commands ArmA|DELETEVEHICLE]]
{{GameCategory|arma1|Scripting Commands}}
[[Category:Command_Group:_Unit_Control|{{uc:{{PAGENAME}}}}]]
{{GameCategory|arma2|Scripting Commands}}
{{GameCategory|arma3|Scripting Commands}}
{{GameCategory|tkoh|Scripting Commands}}
[[Category:Command_Group:_Object_Manipulation|{{uc:{{PAGENAME}}}}]]
[[Category:Command_Group:_Object_Manipulation|{{uc:{{PAGENAME}}}}]]

Revision as of 01:47, 17 January 2021

Logo A0.png1.34
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. 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
Groups:
Object Manipulation

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

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

Notes

Bottom Section

Retrieved from "https://community.bistudio.com/wiki?title=deleteVehicle&oldid=197092"