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: @@
+{{RV|type=function
-{{Function|= Comments
+|game1= arma2
-____________________________________________________________________________________________
+|version1= 1.00
-| arma2 |= Game name
+|game2= arma2oa
+|version2= 1.50
-|1.00|= Game version
+|game3= tkoh
-____________________________________________________________________________________________
+|version3= 1.00
-| <pre>/*
+|game4= arma3
-	File: spawnVehicle.sqf
+|version4= 0.50
-	Description:
+|gr1= Vehicles
-	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.
-	Parameter(s):
+|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]].
-	_this select 0: desired position (Array).
-	_this select 1: desired azimuth (Number).
-	_this select 2: type of the vehicle (String).
-	_this select 3: side or existing group (Side or Group).
-	_this select 4: (optional) force precise position (Bool, default: true).
-	Returns:
+{{Feature|important|Before '''{{arma3}}''' ({{arma2}}, {{tkoh}}):
-	Array:
+* a [[Functions Library|Functions Module]] '''must''' be placed in order to use this function
-: new vehicle (Object).
+* 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.
-: all crew (Array of Objects).
+}}
-: vehicle's group (Group).
-*/
-//Validate parameter count
+|s1= [position, direction, type, sideOrGroup] call [[BIS_fnc_spawnVehicle]]
-</pre><small>''(Placeholder description extracted from the function header by [[BIS_fnc_exportFunctionsToWiki]])''</small> |= Description
-____________________________________________________________________________________________
-| <!-- [] call [[BIS_fnc_spawnVehicle]]; --> |= Syntax
+|p1= position: [[Array]] format [[Position]] - desired [[position]]
-|p1= |= Parameter 1
+|p2= direction: [[Number]] - desired azimuth/[[direction]]
-| |= Return value
+|p3= type: [[String]] - [[typeOf|type]] of the vehicle
-____________________________________________________________________________________________
-|x1= <code></code> |=
+|p4= sideOrGroup: [[Side]] or [[Group]] - side or existing group
-____________________________________________________________________________________________
-| |= See also
+|r1= [[Array]] format [createdVehicle, crew, group]:
+* createdVehicle: [[Object]] - the created vehicle
+* crew: [[Array]] of [[Object]]s - the vehicle's crew members
+* group: [[Group]] - created or passed group
-}}
+|x1= <sqf>[getPos player, 180, "BMP3", east] call BIS_fnc_spawnVehicle;</sqf>
-<h3 style="display:none">Notes</h3>
+|x2= <sqf>
-<dl class="command_description">
+private _result = [getPos player, 180, "BMP3", east] call BIS_fnc_spawnVehicle;
-<!-- Note Section BEGIN -->
-<!-- Note Section END -->
+private _vehicle = _result select 0;
-</dl>
+_result params ["_vehicle", "_crew", "_group"];
+</sqf>
-<h3 style="display:none">Bottom Section</h3>
+|seealso= [[:Category:CfgVehicles]] [[respawnVehicle]] [[createVehicle]] [[createUnit]] [[crew]]
-[[Category:Function Group: Spawning|{{uc:spawnVehicle}}]]
+}}
-[[Category:Functions|{{uc:spawnVehicle}}]]
-[[Category:{{Name|arma2}}: Functions|{{uc:spawnVehicle}}]]
-[[Category:{{Name|arma2oa}}: Functions|{{uc:spawnVehicle}}]]
-[[Category:{{Name|tkoh}}: Functions|{{uc:spawnVehicle}}]]
-[[Category:{{Name|arma3}}: Functions|{{uc:spawnVehicle}}]]