BIS fnc spawnGroup: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "|Game version=" to "|Game version= |gr1 = Object Manipulation |GROUP1=")
m (Text replacement - " |s1=[" to " |s1= [")
(31 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Function|Comments=
{{RV|type=function
____________________________________________________________________________________________


| arma2 |Game name=
|game1= arma2
|1.00|Game version=
|version1= 1.00


|gr1 = Object Manipulation |GROUP1=
|game2= arma2oa
|version2= 1.50


|game2= TKOH |Game2=
|game3= tkoh
|version3= 1.00


|version2= 1.00 |Version2=
|game4= arma3
|version4= 0.50


|arg= |MPARGUMENTS=
|gr1= Object Manipulation


|eff= |MPEFFECTS=
|arg=
____________________________________________________________________________________________


| 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.
|eff=


{{Informative | '''Before {{arma3}}''' 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.}} |Description=
|descr= 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.
____________________________________________________________________________________________


| [position, side, toSpawn, relPositions, ranks, skillRange, ammoRange, randomControls, azimuth, precisePos, maxVehicles] call [[BIS_fnc_spawnGroup]] |Syntax=
{{Feature|informative|'''Before {{arma3}}''' 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.}}


|p1= position: [[Position]] - group's starting position |Parameter 1=
|s1= [position, side, toSpawn, relPositions, ranks, skillRange, ammoRange, randomControls, azimuth, precisePos, maxVehicles] call [[BIS_fnc_spawnGroup]]


|p2= side: [[Side]] - group's side |Parameter 2=
|p1= position: [[Array]] format [[Position]] - group's starting position
 
|p2= side: [[Side]] - group's side


|p3= toSpawn - Can be one of:
|p3= toSpawn - Can be one of:
* [[Array]] - list of character types
* [[Array]] - list of character types
* [[Number]] - amount of characters to spawn
* [[Number]] - amount of characters to spawn
* [[Config]] - [[CfgGroups]] entry |Parameter 3=
* [[Config]] - [[CfgGroups]] entry


|p4= relPositions: [[Array]] of [[Position]]s (Optional, default []) a list of relative positions |Parameter 4=
|p4= relPositions: [[Array]] of [[Position]]s (Optional, default []) a list of relative positions


|p5= ranks: [[Array]] of [[String]]s/[[Number]]s - (Optional, default []) ranks (see [[BIS_fnc_setRank]]) - '''must''' be same size as ''toSpawn''<nowiki/>'s array |Parameter 5=
|p5= ranks: [[Array]] of [[String]]s/[[Number]]s - (Optional, default []) ranks (see [[BIS_fnc_setRank]]) - '''must''' be same size as ''toSpawn''<nowiki/>'s array


|p6= skillRange: [[Array]] of [[Number]]s - (Optional, default []) skill range format [min, max] |Parameter 6=
|p6= skillRange: [[Array]] of [[Number]]s - (Optional, default []) skill range format [min, max]


|p7= ammoRange: [[Array]] of [[Number]]s - (Optional, default []) ammunition range (0..1) format [min, max] |Parameter 7=
|p7= ammoRange: [[Array]] of [[Number]]s - (Optional, default []) ammunition range (0..1) format [min, max]


|p8= randomControls: [[Array]] of [[Number]]s - (Optional, default [-1, 1]) to format [minUnits, chance]:
|p8= randomControls: [[Array]] of [[Number]]s - (Optional, default [-1, 1]) to format [minUnits, chance]:
* minUnits: [[Number]] - (Optional, default -1) amount of mandatory units
* minUnits: [[Number]] - (Optional, default -1) amount of mandatory units
* chance: [[Number]] - (Optional, default -1) spawn chance for remaining units (0..1) |Parameter 8=
* chance: [[Number]] - (Optional, default -1) spawn chance for remaining units in range 0..1


|p9= azimuth: [[Number]] - (Optional, default 0) azimuth/[[direction]] |Parameter 9=
|p9= azimuth: [[Number]] - (Optional, default 0) azimuth/[[direction]]


|p10= precisePos: [[Boolean]] - (Optional, default [[true]]) forces precise position placement |Parameter 10=
|p10= precisePos: [[Boolean]] - (Optional, default [[true]]) forces precise position placement


|p11= maxVehicles: [[Number]] - (Optional, default 10e10) vehicle number limit|Parameter 11=
|p11= maxVehicles: [[Number]] - (Optional, default 10e10) vehicle number limit


| [[Group]] |RETURNVALUE=
|r1= [[Group]]
____________________________________________________________________________________________


|x1= Spawn five random EAST units at aPosition:
|x1= Spawn five random EAST units at aPosition:
<code>[<nowiki/>[[getPos]] aPosition, [[east]], 5] [[call]] [[BIS_fnc_spawnGroup]];</code> |EXAMPLE1=
<sqf>[getPosATL aPosition, east, 5] call BIS_fnc_spawnGroup;</sqf>


|x2= Spawn a Stryker MGS Platoon at marker "tankSpawn":
|x2= Spawn a Stryker MGS Platoon at marker "tankSpawn":
<code>[<nowiki/>[[getMarkerPos]] "tankSpawn", [[side]] [[player]], ([[configFile]] >> "CfgGroups" >> "West" >> "BIS_US" >> "Armored" >> "US_MGSPlatoon")] [[call]] [[BIS_fnc_spawnGroup]];</code> |EXAMPLE2=
<sqf>[getMarkerPos "tankSpawn", side player, (configFile >> "CfgGroups" >> "West" >> "BIS_US" >> "Armored" >> "US_MGSPlatoon")] call BIS_fnc_spawnGroup;</sqf>


|x3= Spawn a TK Militia Medic and Soldier at aPos facing south:
|x3= Spawn a TK Militia Medic and Soldier at aPos facing south:
<code>[<nowiki/>[[getPos]] aPos, [[east]], ["TK_INS_Bonesetter_EP1", "TK_INS_Soldier_2_EP1"],[],[],[],[],[],180] [[call]] [[BIS_fnc_spawnGroup]]</code> |EXAMPLE3=
<sqf>[getPos aPos, east, ["TK_INS_Bonesetter_EP1", "TK_INS_Soldier_2_EP1"],[],[],[],[],[],180] call BIS_fnc_spawnGroup;</sqf>
____________________________________________________________________________________________


| [[:Category:CfgVehicles]] [[Arma 2: CfgVehicles]] [[Arma 3 Assets]] |SEEALSO=
|seealso= [[:Category:CfgVehicles]] [[Arma 2: CfgVehicles]] [[Arma 3 Assets]]
}}
}}


 
{{Note
<h3 style='display:none'>Bottom Section</h3>
|user= Snake Plissken
 
|timestamp= 20160823024200
<dl class="command_description">
|text= Sides are as follow:
</dl>
[[Category:{{Name|arma2oa}}: Functions|{{uc:spawnGroup}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:spawnGroup}}]]
[[Category:Function Group: Spawning|{{uc:spawnGroup}}]]
 
<!-- CONTINUE Notes -->
<dl class="command_description">
<dd class="notedate">Posted on August 23, 2016 - 02:42 (UTC)</dd>
<dt class="note">[[User:Snake Plissken|Snake Plissken]]</dt>
<dd class="note">
Sides are as follow:
* [[west]]/[[blufor]] = BLUFOR
* [[west]]/[[blufor]] = BLUFOR
* [[east]]/[[opfor]] = OPFOR
* [[east]]/[[opfor]] = OPFOR
Line 87: Line 76:


To spawn one BLUFOR group ("MARK1" is the name given to a map marker):
To spawn one BLUFOR group ("MARK1" is the name given to a map marker):
<code>Group_Name_Here = [getMarkerPos "MARK1", WEST, ["B_G_Soldier_A_F", "B_G_Soldier_F", "B_G_Soldier_AR_F", "B_G_Soldier_LAT_F"]] call BIS_fnc_spawnGroup;</code>
<sqf>Group_Name_Here = [getMarkerPos "MARK1", WEST, ["B_G_Soldier_A_F", "B_G_Soldier_F", "B_G_Soldier_AR_F", "B_G_Soldier_LAT_F"]] call BIS_fnc_spawnGroup;</sqf>


Or a random group OPFOR of seven units
Or a random group OPFOR of seven units
<code>Group_Name_Here= [getMarkerPos "MARK1", EAST, 7] call BIS_fnc_spawnGroup; </code>
<sqf>Group_Name_Here = [getMarkerPos "MARK1", EAST, 7] call BIS_fnc_spawnGroup;</sqf>


an independent group:
an independent group:
<code>Group_Name_Here = [getMarkerPos "MARK1", INDEPENDENT, ["I_G_Soldier_A_F", "I_G_Soldier_F", "I_G_Soldier_AR_F", "I_G_Soldier_LAT_F"]] call BIS_fnc_spawnGroup;</code>
<sqf>Group_Name_Here = [getMarkerPos "MARK1", INDEPENDENT, ["I_G_Soldier_A_F", "I_G_Soldier_F", "I_G_Soldier_AR_F", "I_G_Soldier_LAT_F"]] call BIS_fnc_spawnGroup;</sqf>
</dd>
}}


<dd class="notedate">Posted on August 2, 2017 - 19:06 (UTC)</dd>
{{Note
<dt class="note">[[User:Cheitan|Cheitan]]</dt>
|user= Cheitan
<dd class="note">
|timestamp= 20170802190600
When using this function for making a dynamic AI spawn, pay attention to the fact that none of the created groups will be marked for auto-deletion when the group become empty (all members dead). It means that it can be very easy to hit the 144 (288 for A3) max groups per side limitation, implying that no more AI or group can be created afterwards. To avoid this issue on Arma 3, don't forget to use [[deleteGroupWhenEmpty]] command in your script.
|text= When using this function for making a dynamic AI spawn, pay attention to the fact that none of the created groups will be marked for auto-deletion when the group become empty (all members dead). It means that it can be very easy to hit the 144 (288 for A3) max groups per side limitation, implying that no more AI or group can be created afterwards. To avoid this issue on Arma 3, don't forget to use [[deleteGroupWhenEmpty]] command in your script.
</dd>
}}
</dl>
<!-- DISCONTINUE Notes -->

Revision as of 00:12, 13 July 2022

Logo A2.png1.00A2 OA Logo.png1.50tkoh logo small.png1.00Arma 3 logo black.png0.50
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.
ⓘ
Before Arma 3 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.
Execution:
call
Groups:
Object Manipulation

Syntax

Syntax:
[position, side, toSpawn, relPositions, ranks, skillRange, ammoRange, randomControls, azimuth, precisePos, maxVehicles] call BIS_fnc_spawnGroup
Parameters:
position: Array format Position - group's starting position
side: Side - group's side
toSpawn - Can be one of:
relPositions: Array of Positions (Optional, default []) a list of relative positions
ranks: Array of Strings/Numbers - (Optional, default []) ranks (see BIS_fnc_setRank) - must be same size as toSpawn's array
skillRange: Array of Numbers - (Optional, default []) skill range format [min, max]
ammoRange: Array of Numbers - (Optional, default []) ammunition range (0..1) format [min, max]
randomControls: Array of Numbers - (Optional, default [-1, 1]) to format [minUnits, chance]:
  • minUnits: Number - (Optional, default -1) amount of mandatory units
  • chance: Number - (Optional, default -1) spawn chance for remaining units in range 0..1
azimuth: Number - (Optional, default 0) azimuth/direction
precisePos: Boolean - (Optional, default true) forces precise position placement
maxVehicles: Number - (Optional, default 10e10) vehicle number limit
Return Value:
Group

Examples

Example 1:
Spawn five random EAST units at aPosition:
[getPosATL aPosition, 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:
Category:CfgVehicles Arma 2: CfgVehicles Arma 3 Assets

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
Snake Plissken - c
Posted on Aug 23, 2016 - 02:42 (UTC)
Sides are as follow: To spawn one BLUFOR group ("MARK1" is the name given to a map marker):
Group_Name_Here = [getMarkerPos "MARK1", WEST, ["B_G_Soldier_A_F", "B_G_Soldier_F", "B_G_Soldier_AR_F", "B_G_Soldier_LAT_F"]] call BIS_fnc_spawnGroup;
Or a random group OPFOR of seven units
Group_Name_Here = [getMarkerPos "MARK1", EAST, 7] call BIS_fnc_spawnGroup;
an independent group:
Group_Name_Here = [getMarkerPos "MARK1", INDEPENDENT, ["I_G_Soldier_A_F", "I_G_Soldier_F", "I_G_Soldier_AR_F", "I_G_Soldier_LAT_F"]] call BIS_fnc_spawnGroup;
Cheitan - c
Posted on Aug 02, 2017 - 19:06 (UTC)
When using this function for making a dynamic AI spawn, pay attention to the fact that none of the created groups will be marked for auto-deletion when the group become empty (all members dead). It means that it can be very easy to hit the 144 (288 for A3) max groups per side limitation, implying that no more AI or group can be created afterwards. To avoid this issue on Arma 3, don't forget to use deleteGroupWhenEmpty command in your script.
Retrieved from "https://community.bistudio.com/wiki?title=BIS_fnc_spawnGroup&oldid=327456"