Difference between revisions of "BIS fnc spawnVehicle"

From Bohemia Interactive Community
Jump to navigation Jump to search
(Page cleanup)
 
(21 intermediate revisions by 9 users not shown)
Line 1: Line 1:
{{Command|=
+
{{Function
____________________________________________________________________________________________
 
  
| arma2 |=
+
|game1= arma2
 +
|version1= 1.00
  
|1.00|=
+
|game2= TKOH
 +
|version2= 1.00
  
|arg= |= MPARGUMENTS
+
|arg=
  
|eff= |= MPEFFECTS
+
|eff=
____________________________________________________________________________________________
 
  
| 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]].
____________________________________________________________________________________________
 
  
| [position,direction,type,side or group] call '''BIS_fnc_spawnVehicle'''  |=
+
{{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]]
  
|p1= position - desired [[position]] ([[Array]]) |=
+
|p1= position: [[Array]] format [[Position]] - desired [[position]]
  
|p2= direction - desired azimuth/[[direction]] ([[Number]]) |=
+
|p2= direction: [[Number]] - desired azimuth/[[direction]]
  
|p3= type - [[typeOf|type]] of the vehicle ([[String]]) |=
+
|p3= type: [[String]] - [[typeOf|type]] of the vehicle
  
|p4= side or group - side or existing group ([[Side]] or [[Group]]) |=
+
|p4= sideOrGroup: [[Side]] or [[Group]] - side or existing group
  
 +
|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 |RETURNVALUE=
  
| [[Array]] - 0: created vehicle ([[Object]]), 1: all crew ([[Array]] of [[Object|Objects]]), 2: vehicle's group ([[Group]])  |= Return value
 
  
 +
|x1= <code>[<nowiki/>[[getPos]] [[player]], 180, "BMP3", [[east]]] [[call]] [[BIS_fnc_spawnVehicle]];</code>
  
|x1= <code>[getPos mySpawnPos, 180, "BMP3", EAST] call bis_fnc_spawnvehicle</code>|= EXAMPLE1
+
|x2= <code>[[private]] _result = [<nowiki/>[[getPos]] [[player]], 180, "BMP3", [[east]]] [[call]] [[BIS_fnc_spawnVehicle]];
  
__________
+
[[private]] _vehicle = _result [[select]] 0;
 +
{{cc|alternatively, {{arma3}} only}}
 +
_result [[params]] ["_vehicle", "_crew", "_group"];</code>
  
| [[Functions Library]], [[ArmA_2:_CfgVehicles | Arma 2 CfgVehicles]] |= SEEALSO
 
  
| |= MPBEHAVIOUR
+
|seealso= [[:Category:CfgVehicles]], [[createVehicle]], [[createUnit]], [[crew]]
____________________________________________________________________________________________
 
 
}}
 
}}
  
 +
<h3 style="display:none">Notes</h3>
 +
<dl class="command_description">
 +
<!-- Note Section BEGIN -->
 +
 +
<!-- Note Section END -->
 +
</dl>
  
<h3 style='display:none'>Bottom Section</h3>
 
  
[[Category:ArmA 2: Functions|BIS_FNC_SPAWNVEHICLE}}]]
+
[[Category:Functions|{{uc:spawnVehicle}}]]
 +
[[Category:{{arma2}}: Functions|{{uc:spawnVehicle}}]]
 +
[[Category:{{arma2oa}}: Functions|{{uc:spawnVehicle}}]]
 +
[[Category:{{arma3}}: Functions|{{uc:spawnVehicle}}]]
 +
[[Category:{{tkoh}}: Functions|{{uc:spawnVehicle}}]]
 +
[[Category:Function Group: Spawning|{{uc:spawnVehicle}}]]

Latest revision as of 14:37, 2 January 2020

Introduced with Arma 2 version 1.001.00Introduced with Take On Helicopters version 1.001.00
Hover & click on the images for descriptions

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.

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

Execution:
call
See also:
Category:CfgVehiclescreateVehiclecreateUnitcrew

Notes

i
Only post proven facts here. Report bugs on the Feedback Tracker and discuss on the Arma Discord or on the Forums.

Notes