deleteVehicle: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
No edit summary
m (template:command argument fix)
(46 intermediate revisions by 18 users not shown)
Line 1: Line 1:
[[Category:Scripting Commands|DELETEVEHICLE]]
{{Command|= Comments
[[Category:Scripting Commands OFP 1.97|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 |= Arguments in MP


'''Operand types:'''
|eff= global |= Effects in MP
____________________________________________________________________________________________


'''object:''' [[Object]]
| 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=
____________________________________________________________________________________________


'''Type of returned value:'''
| '''deleteVehicle''' object |SYNTAX=


[[Nothing]]
|p1=  object: [[Object]] |PARAMETER1=


'''Compatibility:'''
| [[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=
____________________________________________________________________________________________


Added in version '''1.34'''
| [[createUnit]], [[createVehicleLocal]], [[createVehicle]], [[Arma_3:_Event_Handlers#Deleted | Deleted EH]] |SEEALSO=


'''Description:'''
|mp= |=


Delete any unit or vehicle.
}}


Only vehicles inserted in editor or created during mission can be deleted.
<h3 style="display:none">Notes</h3>
<dl class="command_description">
<!-- Note Section BEGIN -->


Player unit cannot be deleted.
<!-- Note Section END -->
</dl>


<h3 style="display:none">Bottom Section</h3>


'''Example:'''


'''deleteVehicle''' tankOne
[[Category:Scripting Commands|DELETEVEHICLE]]
 
[[Category:Scripting Commands OFP 1.99|DELETEVEHICLE]]
 
[[Category:Scripting Commands OFP 1.96|DELETEVEHICLE]]
'''Comments:'''
[[Category:Scripting Commands OFP 1.46|DELETEVEHICLE]]
 
[[Category:Scripting Commands ArmA|DELETEVEHICLE]]
(1) 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.
[[Category:Scripting Commands ArmA2|{{uc:{{PAGENAME}}}}]]
 
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
( 2) If ''unit1'' is a living unit that is currently located inside a vehicle then<br>
[[Category:Scripting_Commands_Take_On_Helicopters|{{uc:{{PAGENAME}}}}]]
'''deleteVehicle''' ''unit1''<br>
[[Category:Command_Group:_Unit_Control|{{uc:{{PAGENAME}}}}]]
will result in some very strange, and unwelcome, things happening.  A safe way to delete ''unit1'' if it is, or might be, inside a vehicle is:
[[Category:Command_Group:_Object_Manipulation|{{uc:{{PAGENAME}}}}]]
 
[[unassignVehicle]] ''unit1''<br>
''unit1'' [[setPos]] [0,0,0]<br>
'''deleteVehicle''' ''unit1''
 
(3) If you '''deleteVehicle''' ''unit1'' you cannot use ''unit1'' later in commands like '''? alive''' ''unit1'' ''': hint "he's alive"''', it will cause a Crash to Desktop. So you have to ask '''? isNull''' ''unit1'' ''': exit''' before using any command (this goes especially for addon scripts).

Revision as of 15:37, 7 April 2019

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:
Uncategorised

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=121376"