deleteVehicle: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
No edit summary
 
m (Text replacement - "\[\[Category\: ?Command[ _]Group\:.*\|\{\{uc\:\{\{PAGENAME\}\}\}\}\]\] " to "")
(64 intermediate revisions by 21 users not shown)
Line 1: Line 1:
<h2 style="color:#000066">'''deleteVehicle ''object'''''</h2>
{{Command|Comments=
____________________________________________________________________________________________


'''Operand types:'''
| ofp |Game name=


object: [[Object]]
|1.34|Game version=


'''Type of returned value:'''
|arg= global |Multiplayer Arguments=


Nothing
|eff= global |Multiplayer Effects=


'''Description:'''
|gr1= Object Manipulation |GROUP1=
____________________________________________________________________________________________


Delete any unit or vehicle.
| 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>
Only vehicles inserted in editor or created during mission can be deleted.
{{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>
Player unit cannot be deleted.
{{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=
____________________________________________________________________________________________


'''Example:'''
| '''deleteVehicle''' object |SYNTAX=


'''deleteVehicle''' tank
|p1=  object: [[Object]] |PARAMETER1=


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


Since this function will not delete a player unit, a useful multiplayer application is the removal of AI created by players leaving the game.
| [[createUnit]], [[createVehicleLocal]], [[createVehicle]], [[Arma_3:_Event_Handlers#Deleted | Deleted EH]] |SEEALSO=
If you run [[deleteVehicle]] for every playable soldier, the AI units will be removed.
 
|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>
 
 
[[Category:Scripting Commands|DELETEVEHICLE]]
[[Category:Scripting Commands OFP 1.99|DELETEVEHICLE]]
[[Category:Scripting Commands OFP 1.96|DELETEVEHICLE]]
[[Category:Scripting Commands OFP 1.46|DELETEVEHICLE]]
[[Category:Scripting Commands Armed Assault|DELETEVEHICLE]]
[[Category:Scripting Commands Arma 2|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands Take On Helicopters|{{uc:{{PAGENAME}}}}]]
[[Category:Command_Group:_Object_Manipulation|{{uc:{{PAGENAME}}}}]]

Revision as of 16:07, 24 September 2020

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