BIS fnc spawnVehicle: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Generated by BIS_fnc_exportFunctionsToWiki)
 
m (Text replacement - "{{Function|= " to "{{Function|Comments= ")
(21 intermediate revisions by 10 users not shown)
Line 1: Line 1:
{{Function|Comments=
____________________________________________________________________________________________
| arma2 |Game name=
|1.00|Game version=
|game2= TKOH |=
|version2= 1.00 |=
|arg= |MPARGUMENTS=


{{Function|= Comments
|eff= |MPEFFECTS=  
____________________________________________________________________________________________
____________________________________________________________________________________________


| arma2 |= Game name
| 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]].


|1.00|= Game version
|=
____________________________________________________________________________________________
____________________________________________________________________________________________


| <pre>/*
| [position,direction,type,side or group] call '''BIS_fnc_spawnVehicle'''  |=
File: spawnVehicle.sqf


Description:
|p1= position - desired [[position]] ([[Array]]) |Parameter1=
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):
|p2= direction - desired azimuth/[[direction]] ([[Number]]) |=
_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:
|p3= type - [[typeOf|type]] of the vehicle ([[String]]) |=
Array:
 
0: new vehicle (Object).
|p4= side or group - side or existing group ([[Side]] or [[Group]]) |=
1: all crew (Array of Objects).
2: vehicle's group (Group).
*/


//Validate parameter count
</pre><small>''(Placeholder description extracted from the function header by [[BIS_fnc_exportFunctionsToWiki]])''</small> |= Description
____________________________________________________________________________________________


| <!-- [] call [[BIS_fnc_spawnVehicle]]; --> |= Syntax
| [[Array]] - 0: created vehicle ([[Object]]), 1: all crew ([[Array]] of [[Object|Objects]]), 2: vehicle's group ([[Group]])  |RETURNVALUE=


|p1= |= Parameter 1


| |= Return value
|x1= <code>[getPos mySpawnPos, 180, "BMP3", EAST] call bis_fnc_spawnvehicle</code>|EXAMPLE1=  
____________________________________________________________________________________________


|x1= <code></code> |=
__________
____________________________________________________________________________________________


| |= See also
| [[ArmA_2:_CfgVehicles | Arma 2 CfgVehicles]] |SEEALSO=  


|  |MPBEHAVIOUR=
____________________________________________________________________________________________
}}
}}


Line 50: Line 45:
<dl class="command_description">
<dl class="command_description">
<!-- Note Section BEGIN -->
<!-- Note Section BEGIN -->
<dd class="notedate">Posted on January 2, 2011
<dt class="note">'''[[User:Lucky44|Lucky44]]'''
<dd class="note">EDITED: You no longer need to put a Functions Module on the map for this function to work. (As of Arma 3)
<dd class="notedate">Posted on January 23, 2011
<dt class="note">'''[[User:nte|nte]]'''
<dd class="note">If there is no enemy on the map, it will spawn as empty.
<dd class="notedate">Posted on December 24, 2011
<dt class="note">'''[[User:Homer Johnston|Homer Johnston]]'''
<dd class="note">Clarifying the above, you either need to use createCenter to create a side, or place a unit of the desired side on the map, otherwise the vehicle spawns empty.


<!-- Note Section END -->
<!-- Note Section END -->
</dl>
</dl>
<h3 style="display:none">Bottom Section</h3>
[[Category:Function Group: Spawning|{{uc:spawnVehicle}}]]
[[Category:Function Group: Spawning|{{uc:spawnVehicle}}]]
[[Category:Functions|{{uc:spawnVehicle}}]]
[[Category:Functions|{{uc:spawnVehicle}}]]
Line 61: Line 66:
[[Category:{{Name|tkoh}}: Functions|{{uc:spawnVehicle}}]]
[[Category:{{Name|tkoh}}: Functions|{{uc:spawnVehicle}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:spawnVehicle}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:spawnVehicle}}]]
<!-- CONTINUE Notes -->
<dl class="command_description">
<dd class="notedate">Posted on November 8, 2014 - 18:23 (UTC)</dd>
<dt class="note">[[User:Iceman77|Iceman77]]</dt>
<dd class="note">
If the inputted side's center hasn't already been created, the vehicle will spawn empty.
</dd>
</dl>
<dl class="command_description">
<dd class="notedate">Posted on November 27, 2015</dd>
<dt class="note">[[User:Eggbeast|Eggbeast]]</dt>
<dd class="note">
example of how to get your vehicle NAME back <br>
|x1= <code> _vecarray = [getPos mySpawnPos, 180, "BMP3", EAST] call bis_fnc_spawnvehicle
_myvec = _vecarray select 0;<br></code>
</dd>
</dl>
<!-- DISCONTINUE Notes -->

Revision as of 13:12, 3 September 2019

Logo A2.png1.00tkoh logo small.png1.00
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.
Execution:
call
Groups:
Uncategorised

Syntax

Syntax:
[position,direction,type,side or group] call BIS_fnc_spawnVehicle
Parameters:
position - desired position (Array)
direction - desired azimuth/direction (Number)
type - type of the vehicle (String)
side or group - side or existing group (Side or Group)
Return Value:
Array - 0: created vehicle (Object), 1: all crew (Array of Objects), 2: vehicle's group (Group)

Examples

Example 1:
[getPos mySpawnPos, 180, "BMP3", EAST] call bis_fnc_spawnvehicle

Additional Information

See also:
Arma 2 CfgVehicles

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

Notes

Posted on January 2, 2011
Lucky44
EDITED: You no longer need to put a Functions Module on the map for this function to work. (As of Arma 3)
Posted on January 23, 2011
nte
If there is no enemy on the map, it will spawn as empty.
Posted on December 24, 2011
Homer Johnston
Clarifying the above, you either need to use createCenter to create a side, or place a unit of the desired side on the map, otherwise the vehicle spawns empty.
Posted on November 8, 2014 - 18:23 (UTC)
Iceman77
If the inputted side's center hasn't already been created, the vehicle will spawn empty.
Posted on November 27, 2015
Eggbeast
example of how to get your vehicle NAME back
|x1= _vecarray = [getPos mySpawnPos, 180, "BMP3", EAST] call bis_fnc_spawnvehicle _myvec = _vecarray select 0;


Retrieved from "https://community.bistudio.com/wiki?title=BIS_fnc_spawnVehicle&oldid=136622"