BIS fnc spawnVehicle: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "\[\[[cC]ategory:[fF]unctions\|\{\{uc:[a-z A-Z_]*\}\}\]\]" to "")
No edit summary
 
(14 intermediate revisions by one other user not shown)
Line 4: Line 4:
|version1= 1.00
|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
|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]].


{{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 35: Line 37:
* 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= <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;
{{cc|alternatively, {{arma3}} only}}
_result params ["_vehicle", "_crew", "_group"];
_result [[params]] ["_vehicle", "_crew", "_group"];</code>
</sqf>


|seealso= [[:Category:CfgVehicles]], [[createVehicle]], [[createUnit]], [[crew]]
|seealso= [[:Category:CfgVehicles]] [[respawnVehicle]] [[createVehicle]] [[createUnit]] [[crew]]
}}
}}
[[Category:{{arma2}}: Functions|{{uc:spawnVehicle}}]]
[[Category:{{arma2oa}}: Functions|{{uc:spawnVehicle}}]]
[[Category:{{arma3}}: Functions|{{uc:spawnVehicle}}]]
[[Category:{{tkoh}}: Functions|{{uc:spawnVehicle}}]]

Latest revision as of 01:21, 5 March 2024

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