Difference between revisions of "createVehicle"

From Bohemia Interactive Community
Jump to navigation Jump to search
(Added suggestion for code optimization)
m (Some wiki formatting)
 
(164 intermediate revisions by 19 users not shown)
Line 1: Line 1:
{{Command|= Comments
+
{{RV|type=command
____________________________________________________________________________________________
 
  
| ofp |= Game name
+
|game1= ofp
 +
|version1= 1.34
  
|1.34|= Game version
+
|game2= ofpe
 +
|version2= 1.00
  
|eff= global |= Effects in MP
+
|game3= arma1
____________________________________________________________________________________________
+
|version3= 1.00
  
| Create an empty object of given type classname at given position.
+
|game4= arma2
 +
|version4= 1.00
  
For a full class reference see [[:Category:ArmA Classes|Classes]]. |= Description
+
|game5= arma2oa
____________________________________________________________________________________________
+
|version5= 1.50
  
| [[Object]] <nowiki>=</nowiki> type '''createVehicle''' position |= Syntax
+
|game6= tkoh
 +
|version6= 1.00
  
|p1= type: [[String]] - vehicle/object className |= Parameter 1
+
|game7= arma3
 +
|version7= 0.50
  
|p2= position: [[Array]] - format [[Position]] to create the vehicle at |= Parameter 2
+
|eff= global
  
| [[Object]] |= Return value
+
|gr1= Object Manipulation
____________________________________________________________________________________________
 
 
 
|x1= <pre>_jeep = "Jeep" createVehicle (position player);</pre> |= Example 1
 
|x2= <pre>_heli = "AH1Z" createVehicle (getMarkerPos "hspawn");</pre> |= Example 2
 
  
____________________________________________________________________________________________
+
|descr= Creates an empty object of given classname type.
 +
See [[Arma 3 Assets]] / [[Arma 3: createVehicle/vehicles]], or [[:Category:CfgVehicles]] for earlier games.
  
| [[createVehicle array]], [[createVehicleLocal]], [[createUnit]], [[createUnit array]], [[deleteVehicle]], [[createGroup]], [[createCenter]] |= See also
+
{{Feature|informative|
 +
* To create objects of type {{hl|"Logic"}}, use [[createUnit]].
 +
* To create an editable [[:Category: Eden Editor| Eden Editor]] entity, see [[create3DENEntity]].
 +
}}
 +
 
 +
{{Feature|arma3|To avoid vehicle randomisation in {{arma3}}, set the {{hl|BIS_enableRandomization}} variable immediately after creating the vehicle:
 +
<sqf>private _vehicle = "C_Offroad_01_F" createVehicle position player;
 +
_vehicle setVariable ["BIS_enableRandomization", false];</sqf>
 +
Check [[Vehicle Customization (VhC)]] page for more information and settings.}}
 +
 
 +
|s1= type [[createVehicle]] position
 +
 
 +
|p1= type: [[String]] - vehicle/object className
 +
 
 +
|p2= position: [[Array]] format [[Position]] - desired placement position. If the exact position is occupied, nearest empty position is used.
 +
 
 +
|r1= [[Object]]
 +
 
 +
|s2= [[createVehicle]] [type, position, markers, placement, special]
 +
 
 +
|p21= type: [[String]] - vehicle/object className
 +
 
 +
|p22= position: [[Object]]; [[Array]] format [[Position#Introduction|Position2D]] or [[PositionATL]] ([[PositionAGL]] if watercraft or amphibious) - desired placement position
 +
 
 +
|p23= markers: [[Array]] of [[String]]s - (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.
 +
 
 +
|p24= placement: [[Number]] - (Optional, default 0) the vehicle is placed inside a circle with given position as center and placement as its radius.
 +
 
 +
|p25= special: [[String]] - (Optional, default "NONE") can be one of the following:
 +
* {{hl|"NONE"}} - will look for suitable empty position near given position (subject to other placement params) before placing vehicle there.
 +
* {{hl|"CAN_COLLIDE"}} - places vehicle at given position (subject to other placement params), without checking if others objects can cross its 3D model.
 +
* {{hl|"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 {{hl|"NONE"}} is used.
 +
 
 +
|r2= [[Object]] - created vehicle or [[objNull]] if failed
 +
 
 +
|x1= <sqf>_jeep = "Jeep" createVehicle position player;</sqf>
 +
 
 +
|x2= <sqf>_heli = "AH1Z" createVehicle getMarkerPos "hspawn";</sqf>
 +
 
 +
|x3= <sqf>_veh = createVehicle ["ah1w", position player, [], 0, "FLY"];</sqf>
 +
 
 +
|x4= <sqf>_veh = createVehicle ["2S6M_Tunguska", getMarkerPos "marker1", ["marker2", "marker3"], 0, "NONE"];</sqf>
 +
 
 +
|x5= Objects such as
 +
* "test_EmptyObjectForBubbles"
 +
* "test_EmptyObjectForFireBig"
 +
* "test_EmptyObjectForSmoke"
 +
create additional emitters, which are stored in "effects" variable on the object. Since {{arma3}} v1.72 these emitters are automatically deleted when object is deleted
 +
<sqf>[] spawn
 +
{
 +
private _fire = "test_EmptyObjectForFireBig" createVehicle position player;
 +
sleep 5;
 +
deleteVehicle _fire;
 +
};</sqf>
 +
 
 +
|x6= The following explosives (ending with {{hl|_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"
 +
<sqf>_claymore = "ClaymoreDirectionalMine_Remote_Ammo_Scripted" createVehicle position player;
 +
_claymore spawn
 +
{
 +
sleep 5;
 +
_this setDamage 1;
 +
};</sqf>
 +
 
 +
|x7= Add inventory to objects without inventory:
 +
<sqf>_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);
 +
}];</sqf>
 +
 
 +
|x8= Drop player's weapon:
 +
<sqf>_wh = "GroundWeaponHolder_Scripted" createVehicle position player;
 +
player action ["DropWeapon", _wh, currentWeapon player];</sqf>
  
 +
|x9= 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)
 +
<sqf>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;</sqf>
 +
 +
|seealso= [[createVehicleLocal]] [[create3DENEntity]] [[createVehicleCrew]] [[createAgent]] [[createTrigger]] [[createUnit]] [[createMine]] [[deleteVehicle]] [[createGroup]] [[createCenter]] [[setVehiclePosition]]
 
}}
 
}}
  
<h3 style="display:none">Notes</h3>
+
{{Note
<dl class="command_description">
+
|user= MrSanchez
<!-- Note Section BEGIN -->
+
|timestamp= 20150822130400
<dd class="notedate">Posted on January 14, 2010
+
|text= 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.
<dt class="note">'''[[User:Galzohar|Galzohar]]'''<dd class="note">In multiplayer, only run this command on one machine. It will create a the vehicle on all machines every time it is called on any machine.
+
}}
<dd class="notedate">Posted on August 13, 2006 - 12:18
+
 
<dt class="note">'''[[User:Raedor|raedor]]'''<dd class="note">This command sets the created vehicle not exactly at the given position, you have to [[setPos]] it there, if accuracy counts.
+
{{Note
<dd class="notedate">Posted on Jan 20, 2006
+
|user= AgentRevolution
<dt class="note">'''[[User:bdfy|bdfy]]'''<dd class="note">This command sets the created vehicle in the nearest _possible_ position. You can create a dozen of tanks with it - they will appear side by side.
+
|timestamp= 20170516090500
<dd class="notedate">Posted on December 13, 2006 - 12:27
+
|text= For the alternative syntax, if the vehicle has {{hl|c= canFloat = 1;}} in its config class (e.g. boats and wheeled APCs), the command expects [[Position#PositionAGL|PositionAGL]], and otherwise always [[Position#PositionATL|PositionATL]].
<dt class="note">'''[[User:Salisan|Salisan]]'''<dd class="note">Observe that buildings with the default destrType will not work correctly in multiplayer in Armed Assault when created with this command. The Destruction effect will only be displayed where the building is local.
+
}}
<dd class="notedate">Posted on Oct 18, 2009 - 05:42
 
<dt class="note">'''[[User:Canukausiuka|Canukausiuka]]'''<dd class="note>As of Arma2, this command cannot be used to create game logics [http://forums.bistudio.com/showthread.php?t=81964 (source)].  Use [[createUnit]] instead.
 
<dd class="notedate">Posted on January 26 2014 - 20:12
 
<dt class="note">'''[[User:Katulobotomia|Katulobotomia]]'''<dd class="note">Using getPosATL should work, if otherwise you are struggling to get a the proper position coordinates.
 
<dd class="notedate">Posted on March 27 2014 - 02:15
 
<dt class="note">'''[[User:Floriangeyer|Floriangeyer]]'''<dd class="note">According to [[Code Optimisation]], this function is considered deprecated and should be used [[createVehicle array]] instead.
 
<!-- Note Section END -->
 
</dl>
 
  
<h3 style="display:none">Bottom Section</h3>
+
{{Note
 +
|user= demellion
 +
|timestamp= 20181102121600
 +
|text= '''WARNING:''' Do not instigate [[createVehicle]] or [[createVehicleLocal]] within a server function executed with [[Arma 3: Functions Library#Pre_and_Post_Init|preInit]] flag.<br>
 +
This will cause ''"You cannot play/edit this mission"'' for a vehicles compiled from a [[Arma_3_Startup_Parameters|-mod]] and make server skip/loop that mission init.
 +
}}
  
[[Category:Scripting Commands|CREATEVEHICLE]]
+
{{Note
[[Category:Scripting Commands OFP 1.96|CREATEVEHICLE]]
+
|user= R3vo
[[Category:Scripting Commands OFP 1.46|CREATEVEHICLE]]
+
|timestamp= 20190810091000
[[Category:Scripting Commands ArmA|CREATEVEHICLE]]
+
|text= The main syntax creates vehicles at ground level ignoring the Z in ''pos'' and is also faster than the alternative syntax.
[[Category:Command_Group:_Object_Manipulation|{{uc:{{PAGENAME}}}}]]
+
<sqf>"vehclass" createVehicle pos;</sqf> This is equivalent to <sqf>createVehicle ["vehclass", [pos select 0, pos select 1, 0], [], 0, "NONE"];</sqf>
[[Category:Scripting Commands ArmA2|{{uc:{{PAGENAME}}}}]]
+
}}
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
+
 
[[Category:Scripting_Commands_Take_On_Helicopters|{{uc:{{PAGENAME}}}}]]
+
{{Note
 +
|user= DreadedEntity
 +
|timestamp= 20220313172236
 +
|text= Objects are created with a [[vectorUp]] of [[surfaceNormal|terrain surface normal]]. If you are creating new buildings to add to the map, you will probably want to call [[setVectorUp]] on the newly-spawned object.
 +
<sqf>
 +
_veh = createVehicle [etc...];
 +
_veh setVectorUp [0,0,1];
 +
</sqf>
 +
}}

Latest revision as of 14:57, 22 May 2022

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 CfgVehicles for earlier games.
Arma 3
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: Array format 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: String - vehicle/object className
position: Object; Array format Position2D or PositionATL (PositionAGL if watercraft or amphibious) - desired placement position
markers: Array of Strings - (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:
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.72 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 create3DENEntity 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 Aug 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)
AgentRevolution
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 Nov 02, 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 Aug 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 alternative syntax.
"vehclass" createVehicle pos;
This is equivalent to
createVehicle ["vehclass", [pos select 0, pos select 1, 0], [], 0, "NONE"];
Posted on Mar 13, 2022 - 17:22 (UTC)
DreadedEntity
Objects are created with a vectorUp of terrain surface normal. If you are creating new buildings to add to the map, you will probably want to call setVectorUp on the newly-spawned object.
_veh = createVehicle [etc...]; _veh setVectorUp [0,0,1];