createVehicle

Game1 needed - Version1 needed

1.00

Hover & click on the images for description

Description

Description:: Creates an empty object of given classname type. See Arma 3 Assets / Arma 3: createVehicle/vehicles, or Category:CfgVehicles for earlier games.
ⓘ
For objects of type "Logic" use createUnit instead.

To avoid vehicle randomisation in Arma 3, set the BIS_enableRandomization variable immediately after creating the vehicle:
private _vehicle = "C_Offroad_01_F" createVehicle position player; _vehicle setVariable ["BIS_enableRandomization", false];
Check Vehicle Customization (VhC) page for more information and settings.
Groups:: Object Manipulation

Syntax

Syntax:: type createVehicle position
Parameters:: type: String - vehicle/object className
: position: Position - Desired placement position. If the exact position is occupied, nearest empty position is used.
Return Value:: Object

Alternative Syntax

Syntax:

createVehicle [type, position, markers, placement, special]

Parameters:

[type, position, markers, placement, special]: Array

type: String - vehicle/object className

position: PositionATL (PositionAGL if boat or amphibious), Position2D, or Object - desired placement position

markers: Array - (Optional, default []) if the markers array contains any markers, the position is randomly picked from array of given markers plus desired placement position. If any of the markers were given z coordinate with setMarkerPos, the vehicle will also be created at given z coordinate.

placement: Number - (Optional, default 0) the vehicle is placed inside a circle with given position as center and placement as its radius.

special: String - (Optional, default "NONE") can be one of the following:

"NONE" - will look for suitable empty position near given position (subject to other placement params) before placing vehicle there.
"CAN_COLLIDE" - places vehicle at given position (subject to other placement params), without checking if others objects can cross its 3D model.
"FLY" - if vehicle is capable of flying and has crew, it will be made airborne at default height.

If special is "" or not specified, default "NONE" is used.

Return Value:

Object - created vehicle or objNull if failed

Examples

Example 1:

_jeep = "Jeep" createVehicle position player;

Example 2:

_heli = "AH1Z" createVehicle getMarkerPos "hspawn";

Example 3:

_veh = createVehicle ["ah1w", position player, [], 0, "FLY"];

Example 4:

_veh = createVehicle ["2S6M_Tunguska", getMarkerPos "marker1", ["marker2", "marker3"], 0, "NONE"];

Example 5:

Objects such as

"test_EmptyObjectForBubbles"
"test_EmptyObjectForFireBig"
"test_EmptyObjectForSmoke"

create additional emitters, which are stored in "effects" variable on the object. Since Arma 3 v1.71 these emitters are automatically deleted when object is deleted

[] spawn
{
	private _fire = "test_EmptyObjectForFireBig" createVehicle position player;
	sleep 5;
	deleteVehicle _fire;
};

Example 6:

The following explosives (ending with _Scripted) can be set off by applying setDamage 1 to them for ease of scripting:

"DemoCharge_Remote_Ammo_Scripted"
"SatchelCharge_Remote_Ammo_Scripted"
"ClaymoreDirectionalMine_Remote_Ammo_Scripted"

_claymore = "ClaymoreDirectionalMine_Remote_Ammo_Scripted" createVehicle position player;
_claymore spawn
{
	sleep 5;
	_this setDamage 1;
};

Example 7:

Add inventory to objects without inventory:

_boxes = "Land_Pallet_MilBoxes_F" createVehicle position player;
_cargo = "Supply500" createVehicle [0,0,0];
_cargo attachTo [_boxes, [0,0,0.85]];

// optional for objects that can take damage
_boxes addEventHandler ["Killed",
{
	{
		detach _x,
		deleteVehicle _x;
	}
	forEach attachedObjects (_this select 0);
}];

Example 8:

Drop player's weapon:

_wh = "GroundWeaponHolder_Scripted" createVehicle position player;
player action ["DropWeapon", _wh, currentWeapon player];

Example 9:

The following weapon holders (ending with _Scripted) do not auto-delete when empty. It is up to the mission maker to take care of these:

"GroundWeaponHolder_Scripted"
"WeaponHolderSimulated_Scripted"
"Weapon_Empty" (a special weaponholder that displays only a single weapon, even if it contains magazines for this weapon)

private _weaponHolder = createVehicle ["Weapon_Empty", getPosATL player, [], 0, "CAN_COLLIDE"];
_weaponHolder addWeaponCargo ["arifle_Katiba_F", 1];
hint "You have 5 seconds to grab this weapon";
sleep 5;
deleteVehicle _weaponHolder;

Additional Information

See also:: createVehicleLocal createVehicleCrew createAgent createTrigger createUnit createMine deleteVehicle createGroup createCenter setVehiclePosition

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


: Posted on August 22, 2015 - 13:04 (UTC)
MrSanchez: GroundWeaponHolder class is automatically deleted when empty after 0.5 to 1 seconds in A3 1.48. The exact delay is random but never lower than 0.50 secs after creation. You can stop deletion by adding something (cargo) to it within 0.5 seconds.

: Posted on May 16, 2017 - 09:05 (UTC)
AgentRev: For the alternative syntax, if the vehicle has canFloat = 1; in its config class (e.g. boats and wheeled APCs), the command expects PositionAGL, and otherwise always PositionATL.

: Posted on November 2, 2018 - 12:16 (UTC)
demellion: WARNING: Do not instigate createVehicle or createVehicleLocal within a server function executed with preInit flag.
This will cause "You cannot play/edit this mission" for a vehicles compiled from a -mod and make server skip/loop that mission init.

: Posted on August 10, 2019 - 09:10 (UTC)
R3vo: The main syntax creates vehicles at ground level ignoring the Z in pos and is also faster than the alternativ syntax. "vehclass" createVehicle pos; This is equivalent to createVehicle ["vehclass", [pos select 0, pos select 1, 0], [], 0, "NONE"];