Difference between revisions of "deleteVehicle"

From Bohemia Interactive Community
Jump to navigation Jump to search
(see also)
m (template:command argument fix)
Line 13: Line 13:
 
| 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>
 
| 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>
 
{{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
+
{{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=
 
____________________________________________________________________________________________
 
____________________________________________________________________________________________
  
−
| '''deleteVehicle''' object |= Syntax
+
| '''deleteVehicle''' object |SYNTAX=
  
−
|p1=  object: [[Object]] |= Parameter 1
+
|p1=  object: [[Object]] |PARAMETER1=
  
−
| [[Nothing]] |= Return value
+
| [[Nothing]] |RETURNVALUE=
 
____________________________________________________________________________________________
 
____________________________________________________________________________________________
 
   
 
   
−
|x1= <code>[[deleteVehicle]] _house1;</code> |= Example 1
+
|x1= <code>[[deleteVehicle]] _house1;</code> |EXAMPLE1=
 
|x2= Deleting a vehicle with crew: <code>// might want to make sure that the car is local
 
|x2= Deleting a vehicle with crew: <code>// might want to make sure that the car is local
 
{car [[deleteVehicleCrew]] _x} [[forEach]] [[crew]] car;
 
{car [[deleteVehicleCrew]] _x} [[forEach]] [[crew]] car;
−
[[deleteVehicle]] car;</code>|= Example 2
+
[[deleteVehicle]] car;</code>|EXAMPLE2=
 
____________________________________________________________________________________________
 
____________________________________________________________________________________________
  
−
| [[createUnit]], [[createVehicleLocal]], [[createVehicle]], [[Arma_3:_Event_Handlers#Deleted | Deleted EH]] |= See also
+
| [[createUnit]], [[createVehicleLocal]], [[createVehicle]], [[Arma_3:_Event_Handlers#Deleted | Deleted EH]] |SEEALSO=
  
 
|mp= |=
 
|mp= |=

Revision as of 15:37, 7 April 2019

Introduced with Operation Flashpoint version 1.341.34Arguments of this scripting command don't have to be local to the client the command is executed onEffects of this scripting command are broadcasted over the network and happen on every computer in the network
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

Notes

i
Only post proven facts here. Report bugs on the feedback tracker. Use the Talk page or the Forums for discussions.

Add New Note | How To

Notes

Bottom Section

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