BIS fnc spawnVehicle: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "<code>([^<]*)<nowiki\/>\[\[([a-zA-Z0-9_]+)\]\](.*)<\/code>" to "<code>$1$2$3</code>")
m (Some wiki formatting)
Line 17: Line 17:
|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]].
|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]].


{{Feature | 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 [[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.
* 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.
Line 37: Line 37:
* group: [[Group]] - created or passed group
* group: [[Group]] - created or passed group


|x1= <code>[getPos [[player]], 180, "BMP3", [[east]]] [[call]] [[BIS_fnc_spawnVehicle]];</code>
|x1= <sqf>[getPos player, 180, "BMP3", east] call BIS_fnc_spawnVehicle;</sqf>


|x2= <code>[[private]] _result = [<nowiki/>[[getPos]] [[player]], 180, "BMP3", [[east]]] [[call]] [[BIS_fnc_spawnVehicle]];
|x2= <sqf>
private _result = [getPos player, 180, "BMP3", east] call BIS_fnc_spawnVehicle;


[[private]] _vehicle = _result [[select]] 0;
private _vehicle = _result select 0;
// alternatively, {{arma3 only}}
_result params ["_vehicle", "_crew", "_group"];
_result [[params]] ["_vehicle", "_crew", "_group"];</code>
</sqf>


|seealso= [[:Category:CfgVehicles]] [[createVehicle]] [[createUnit]] [[crew]]
|seealso= [[:Category:CfgVehicles]] [[createVehicle]] [[createUnit]] [[crew]]
}}
}}

Revision as of 13:44, 13 July 2022

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 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