BIS fnc spawnVehicle: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - " *\| *([Cc]omments|COMMENTS|[Gg]ame [Nn]ame|Game [Vv]ersion|Game Version \(number surrounded by NO SPACES\)|Multiplayer Arguments \("local" or "global"\)|Multiplayer Effects \("local" or "global"\)|Multiplayer Execution \("server" o...)
m (Text replacement - " {3,}\|" to " |")
Line 12: Line 12:


|gr1 = Vehicles
|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]].
|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]].
Line 20: Line 19:
* 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.
}}
}}


|s1= [position, direction, type, sideOrGroup] call [[BIS_fnc_spawnVehicle]]
|s1= [position, direction, type, sideOrGroup] call [[BIS_fnc_spawnVehicle]]
Line 36: Line 34:
* crew: [[Array]] of [[Object]]s - the vehicle's crew members
* crew: [[Array]] of [[Object]]s - the vehicle's crew members
* group: [[Group]] - created or passed group
* group: [[Group]] - created or passed group


|x1= <code>[<nowiki/>[[getPos]] [[player]], 180, "BMP3", [[east]]] [[call]] [[BIS_fnc_spawnVehicle]];</code>
|x1= <code>[<nowiki/>[[getPos]] [[player]], 180, "BMP3", [[east]]] [[call]] [[BIS_fnc_spawnVehicle]];</code>
Line 45: Line 42:
{{cc|alternatively, {{arma3}} only}}
{{cc|alternatively, {{arma3}} only}}
_result [[params]] ["_vehicle", "_crew", "_group"];</code>
_result [[params]] ["_vehicle", "_crew", "_group"];</code>


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

Revision as of 00:01, 19 January 2021

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; // alternatively, Arma 3 only _result params ["_vehicle", "_crew", "_group"];

Additional Information

See also:
Category:CfgVehiclescreateVehiclecreateUnitcrew

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