deleteVehicle: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
No edit summary
m (template:command argument fix)
(7 intermediate revisions by 2 users not shown)
Line 6: Line 6:
|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=
____________________________________________________________________________________________
____________________________________________________________________________________________


| Deletes an object.<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>
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 cannot be removed. <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>
Deleting a vehicle, which is still being accessed by a running script, can result in a CTD.|= 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= <code>{
|x2= Deleting a vehicle with crew: <code>// might want to make sure that the car is local
_x [[action]] ["Eject", car];
{car [[deleteVehicleCrew]] _x} [[forEach]] [[crew]] car;
} [[forEach]] [[crew]] car;
[[deleteVehicle]] car;</code>|EXAMPLE2=
[[deleteVehicle]] car;</code> |= Example 1
|x3= Objects such as
* test_EmptyObjectForBubbles
* test_EmptyObjectForFireBig
* test_EmptyObjectForSmoke
create additional emitters that needs to be deleted first before deleting the object itself: <code>///--- function to delete test object (MP compatible)
fnc_deleteTestObj = {
_this [[addMPEventHandler]] ["MPKilled", {
_this = _this [[select]] 0;
{
[[deleteVehicle]] _x;
} [[forEach]] (_this [[getVariable]] ["effects", []]);
[[if]] ([[isServer]]) [[then]] {
[[deleteVehicle]] _this;
};
}];
_this [[setDamage]] 1;
};
///--- example
[] [[spawn]] {
_fire = "test_EmptyObjectForFireBig" [[createVehicle]] [[position]] [[player]];
[[sleep]] 5;
_fire [[call]] fnc_deleteTestObj;
};</code> |= Example 3
____________________________________________________________________________________________
____________________________________________________________________________________________


| [[createUnit]], [[createVehicleLocal]], [[createVehicle]] |= See also
| [[createUnit]], [[createVehicleLocal]], [[createVehicle]], [[Arma_3:_Event_Handlers#Deleted | Deleted EH]] |SEEALSO=


|mp= A deleted player unit will stay visible until that player has disconnected. |=
|mp= |=


}}
}}

Revision as of 12:07, 5 August 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=125528"