Difference between revisions of "createVehicle"

From Bohemia Interactive Community
Jump to navigation Jump to search
(Note removed. Assuming deprecation of a certain feature of the game based on vague note left by another user and promoting this as general tendency is bad practice for biki.)
(added alt syntax)
Line 9: Line 9:
 
____________________________________________________________________________________________
 
____________________________________________________________________________________________
  
−
| Creates an empty object of given type classname and attempts to place it at given position. If the exact position is occupied, nearest empty position is used.
+
| Creates an empty object of given classname type (See [[Arma 3 Assets]])
  
−
For a full class reference see [[:Category:ArmA Classes|Classes]]. |= Description
+
<br><br>For a class reference from older games see [[:Category:ArmA Classes|Classes]]. |= Description
 
____________________________________________________________________________________________
 
____________________________________________________________________________________________
  
Line 18: Line 18:
 
|p1= type: [[String]] - vehicle/object className |= Parameter 1
 
|p1= type: [[String]] - vehicle/object className |= Parameter 1
  
−
|p2= position: [[Array]] - format [[Position]] to create the vehicle at |= Parameter 2
+
|p2= position: [[Position]] - Desired placement position. If the exact position is occupied, nearest empty position is used.
 +
|= Parameter 2
  
 
| [[Object]] |= Return value
 
| [[Object]] |= Return value
 +
____________________________________________________________________________________________
 +
 +
 +
| s2= '''createVehicle''' [type, position, markers, placement, special] |= Syntax
 +
 +
|p21= [type, position, markers, placement, special]: [[Array]] |= Parameter 1
 +
 +
|p22= type: [[String]] - vehicle/object className |= Parameter 2
 +
 +
|p23= position: [[Position]] - Desired placement position |= Parameter 3
 +
 +
|p24= markers: [[Array]] - If the markers array contains several marker names, the position of a random one is used. Otherwise, the given position is used.|= Parameter 4
 +
 +
|p25= placement: [[Number]] - The vehicle is placed inside a circle with given position as center and placement as its radius|= Parameter 5
 +
 +
|p26= special: [[String]] - <tt>"NONE"</tt>, <tt>"FLY"</tt> and <tt>"FORM"</tt>. <tt>"CAN_COLLIDE"</tt> creates the vehicle exactly where asked, not checking if others objects can cross its 3D model. |= Parameter 6
 +
 +
| r2= [[Object]] |= Return value
 
____________________________________________________________________________________________
 
____________________________________________________________________________________________
 
   
 
   
−
|x1= <code>_jeep = "Jeep" [[createVehicle]] ([[position]] [[player]]);</code> |= Example 1
+
|x1= <code>_jeep = "Jeep" [[createVehicle]] [[position]] [[player]];</code> |= Example 1
−
|x2= <code>_heli = "AH1Z" [[createVehicle]] ([[getMarkerPos]] "hspawn");</code> |= Example 2
+
|x2= <code>_heli = "AH1Z" [[createVehicle]] [[getMarkerPos]] "hspawn";</code> |= Example 2
 +
|x3= <code>_veh = [[createVehicle]] ["ah1w", [[position]] [[player]], [], 0, "FLY"];</code> |= Example 3
 +
|x4 = <code>_veh = [[createVehicle]] ["2S6M_Tunguska", [[getMarkerPos]] "marker1", ["marker2","marker3"], 0, "NONE"];</code> |= Example 4
  
 
____________________________________________________________________________________________
 
____________________________________________________________________________________________

Revision as of 08:57, 12 September 2014

Logo A0.png1.34
GEGlobal
Hover & click on the images for description

Description

Description:
Creates an empty object of given classname type (See Arma 3 Assets)

For a class reference from older games see Classes.
Groups:
Uncategorised

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: Position - Desired placement position
markers: Array - If the markers array contains several marker names, the position of a random one is used. Otherwise, the given position is used.
placement: Number - The vehicle is placed inside a circle with given position as center and placement as its radius
special: String - "NONE", "FLY" and "FORM". "CAN_COLLIDE" creates the vehicle exactly where asked, not checking if others objects can cross its 3D model.
Return Value:
Object

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"];

Additional Information

See also:
createVehicle arraycreateVehicleLocalcreateVehicleCrewcreateUnitcreateUnit arraydeleteVehiclecreateGroupcreateCenter

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

Posted on January 14, 2010
Galzohar
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.
Posted on August 13, 2006 - 12:18
raedor
This command sets the created vehicle not exactly at the given position, you have to setPos it there, if accuracy counts.
Posted on Jan 20, 2006
bdfy
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.
Posted on December 13, 2006 - 12:27
Salisan
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.
Posted on Oct 18, 2009 - 05:42
Canukausiuka
As of Arma2, this command cannot be used to create game logics (source). Use createUnit instead.
Posted on January 26 2014 - 20:12
Katulobotomia
Using getPosATL should work, if otherwise you are struggling to get a the proper position coordinates.

Bottom Section

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