BIS fnc spawnVehicle: Difference between revisions

Latest revision as of 01:21, 5 March 2024

1.00

1.50

1.00

0.50

Hover & click on the images for description

Description

Description:

Function to spawn a certain vehicle type with all crew (including turrets). The vehicle can either become part of an existing group or create a new group.

⚠

Before Arma 3 (Arma 2, Take On Helicopters):

a Functions Module must be placed in order to use this function
a side's center has to exist (by already having a unit of said side on the map)/be created via createCenter or the vehicle will spawn empty.

Execution:

call

Groups:

Vehicles

Syntax

Syntax:

[position, direction, type, sideOrGroup] call BIS_fnc_spawnVehicle

Parameters:

position: Array format Position - desired position

direction: Number - desired azimuth/direction

type: String - type of the vehicle

sideOrGroup: Side or Group - side or existing group

Return Value:

Array format [createdVehicle, crew, group]:

createdVehicle: Object - the created vehicle
crew: Array of Objects - the vehicle's crew members
group: Group - created or passed group

Examples

Example 1:: [getPos player, 180, "BMP3", east] call BIS_fnc_spawnVehicle;
Example 2:: private _result = [getPos player, 180, "BMP3", east] call BIS_fnc_spawnVehicle; private _vehicle = _result select 0; _result params ["_vehicle", "_crew", "_group"];

Additional Information

See also:: Category:CfgVehicles respawnVehicle createVehicle createUnit crew

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

@@ Line 1: / Line 1: @@
-{{Function
+{{RV|type=function
 |game1= arma2
 |version1= 1.00
-|game2= TKOH
+|game2= arma2oa
-|version2= 1.00
+|version2= 1.50
-|arg=
+|game3= tkoh
+|version3= 1.00
-|eff=
+|game4= arma3
+|version4= 0.50
-|gr1 = Vehicles |GROUP1=
+|gr1= Vehicles
 |descr= Function to spawn a certain vehicle type with all crew (including turrets). The vehicle can either become part of an existing [[group]] or create a new [[group]].
-{{Important | Before '''{{arma3}}''' ({{arma2}}, {{tkoh}}):
+{{Feature|important|Before '''{{arma3}}''' ({{arma2}}, {{tkoh}}):
 * a [[Functions Library|Functions Module]] '''must''' be placed in order to use this function
 * a side's [[createCenter|center]] has to exist (by already having a unit of said side on the map)/be created ''via'' [[createCenter]] or the vehicle will spawn empty.
 }}
 |s1= [position, direction, type, sideOrGroup] call [[BIS_fnc_spawnVehicle]]
@@ Line 35: / Line 35: @@
 * createdVehicle: [[Object]] - the created vehicle
 * crew: [[Array]] of [[Object]]s - the vehicle's crew members
-* group: [[Group]] - created or passed group |RETURNVALUE=
+* group: [[Group]] - created or passed group
-|x1= <code>[<nowiki/>[[getPos]] [[player]], 180, "BMP3", [[east]]] [[call]] [[BIS_fnc_spawnVehicle]];</code>
-|x2= <code>[[private]] _result = [<nowiki/>[[getPos]] [[player]], 180, "BMP3", [[east]]] [[call]] [[BIS_fnc_spawnVehicle]];
+|x1= <sqf>[getPos player, 180, "BMP3", east] call BIS_fnc_spawnVehicle;</sqf>
-[[private]] _vehicle = _result [[select]] 0;
+|x2= <sqf>
-{{cc|alternatively, {{arma3}} only}}
+private _result = [getPos player, 180, "BMP3", east] call BIS_fnc_spawnVehicle;
-_result [[params]] ["_vehicle", "_crew", "_group"];</code>
+private _vehicle = _result select 0;
+_result params ["_vehicle", "_crew", "_group"];
+</sqf>
-|seealso= [[:Category:CfgVehicles]], [[createVehicle]], [[createUnit]], [[crew]]
+|seealso= [[:Category:CfgVehicles]] [[respawnVehicle]] [[createVehicle]] [[createUnit]] [[crew]]
 }}
-<h3 style="display:none">Notes</h3>
-<dl class="command_description">
-<!-- Note Section BEGIN -->
-<!-- Note Section END -->
-</dl>
-[[Category:Functions|{{uc:spawnVehicle}}]]
-[[Category:{{arma2}}: Functions|{{uc:spawnVehicle}}]]
-[[Category:{{arma2oa}}: Functions|{{uc:spawnVehicle}}]]
-[[Category:{{arma3}}: Functions|{{uc:spawnVehicle}}]]
-[[Category:{{tkoh}}: Functions|{{uc:spawnVehicle}}]]