Difference between revisions of "BIS fnc spawnVehicle"

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Generated by BIS_fnc_exportFunctionsToWiki)
 
(Page cleanup)
 
(22 intermediate revisions by 10 users not shown)
Line 1: Line 1:
 +
{{Function
  
{{Function|= Comments
+
|game1= arma2
____________________________________________________________________________________________
+
|version1= 1.00
  
| arma2 |= Game name
+
|game2= TKOH
 +
|version2= 1.00
  
|1.00|= Game version
+
|arg=
____________________________________________________________________________________________
 
  
| <pre>/*
+
|eff=
File: spawnVehicle.sqf
 
  
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.
 
  
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:
+
{{Important | Before '''{{arma3}}''' ({{arma2}}, {{tkoh}}):
Array:
+
* a [[Functions Library|Functions Module]] '''must''' be placed in order to use this function
0: 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.
1: all crew (Array of Objects).
+
}}
2: vehicle's group (Group).
+
 
*/
+
 
 +
|s1= [position, direction, type, sideOrGroup] call [[BIS_fnc_spawnVehicle]]
 +
 
 +
|p1= position: [[Array]] format [[Position]] - desired [[position]]
 +
 
 +
|p2= direction: [[Number]] - desired azimuth/[[direction]]
 +
 
 +
|p3= type: [[String]] - [[typeOf|type]] of the vehicle
  
//Validate parameter count
+
|p4= sideOrGroup: [[Side]] or [[Group]] - side or existing group
</pre><small>''(Placeholder description extracted from the function header by [[BIS_fnc_exportFunctionsToWiki]])''</small> |= Description
 
____________________________________________________________________________________________
 
  
| <!-- [] call [[BIS_fnc_spawnVehicle]]; --> |= Syntax
+
|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=
  
|p1= |= Parameter 1
 
  
| |= Return value
+
|x1= <code>[<nowiki/>[[getPos]] [[player]], 180, "BMP3", [[east]]] [[call]] [[BIS_fnc_spawnVehicle]];</code>
____________________________________________________________________________________________
 
  
|x1= <code></code> |=
+
|x2= <code>[[private]] _result = [<nowiki/>[[getPos]] [[player]], 180, "BMP3", [[east]]] [[call]] [[BIS_fnc_spawnVehicle]];
____________________________________________________________________________________________
 
  
| |= See also
+
[[private]] _vehicle = _result [[select]] 0;
 +
{{cc|alternatively, {{arma3}} only}}
 +
_result [[params]] ["_vehicle", "_crew", "_group"];</code>
  
 +
 +
|seealso= [[:Category:CfgVehicles]], [[createVehicle]], [[createUnit]], [[crew]]
 
}}
 
}}
  
Line 54: Line 55:
 
</dl>
 
</dl>
  
<h3 style="display:none">Bottom Section</h3>
+
 
 +
[[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}}]]
 
[[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}}]]
 

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