BIS fnc spawnGroup: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
mNo edit summary
No edit summary
Line 62: Line 62:
<dl class="command_description">
<dl class="command_description">
<!-- Note Section BEGIN -->
<!-- Note Section BEGIN -->
[[User:kylania | kylania]] 2010-10-22<br/>
[[User:kylania | kylania]] 2011-8-15<br/>
Use the following for the Type string in the configFile entry:
Use the following for the Type string in the configFile entry:


Line 70: Line 70:
  Motorized
  Motorized
  Armored  
  Armored  
The randomization controls is an array:  [2, .5]  Would be 2 units spawned with a 50% chance the other units would be spawned.  The chance is a number from 0 to 1.
Also the last optional argument is azimuth, but doesn't display in the text above. :)  There's an example for it though.


<!-- Note Section END -->
<!-- Note Section END -->

Revision as of 21:00, 15 August 2011

Hover & click on the images for description

Description

Description:
Function which handles the spawning of a dynamic group of characters. The composition of the group can be passed to the function. Alternatively a number can be passed and the function will spawn that amount of characters with a random type. A side's Center must have been created before a group may be spawned. Either by using createCenter or an editor placed (0% Probability of Presence is fine) unit of the appropriate side.
Groups:
Uncategorised

Syntax

Syntax:
[position, side, character details, relative positions, list of ranks, skill range, ammo count range, randomization controls, azimuth] call BIS_fnc_spawnGroup
Parameters:
position - group's starting position (Array)
side - group's Side (Side)
character details - Can be three different types: a list of character types (Array), an amount of characters to spawn (Number) or a CfgGroups entry (Config)
(optional) a list of relative positions (Array)
(optional) a list of ranks (Array)
(optional) skill range (Array)
(optional) ammunition count range (Array)
(optional) randomization controls (Array) 0: amount of mandatory units (Number) 1: spawn chance for remaining units (Number)
(optional) azimuth/Direction (Number)
Return Value:
(Group)

Examples

Example 1:
Spawn five random EAST units at aPos: [getPos aPos, EAST, 5] call BIS_fnc_spawnGroup
Example 2:
Spawn a Stryker MGS Platoon at marker "tankSpawn": [getMarkerPos "tankSpawn", side player, (configFile >> "CfgGroups" >> "West" >> "BIS_US" >> "Armored" >> "US_MGSPlatoon")] call BIS_fnc_spawnGroup
Example 3:
Spawn a TK Militia Medic and Soldier at aPos facing south: [getPos aPos, EAST, ["TK_INS_Bonesetter_EP1", "TK_INS_Soldier_2_EP1"],[],[],[],[],[],180] call BIS_fnc_spawnGroup

Additional Information

See also:
Functions Library 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


Bottom Section

kylania 2011-8-15
Use the following for the Type string in the configFile entry: Infantry Air Mechanized Motorized Armored The randomization controls is an array: [2, .5] Would be 2 units spawned with a 50% chance the other units would be spawned. The chance is a number from 0 to 1. Also the last optional argument is azimuth, but doesn't display in the text above. :) There's an example for it though.