createGroup: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
mNo edit summary
(alt syntax, see also)
Line 9: Line 9:
____________________________________________________________________________________________
____________________________________________________________________________________________


| Creates a new AI group for the given [[Side]]. An HQ (center) for that side must already be in the Mission.sqm or have been initialized with [[createCenter]]. For the available sides see [[Side]].  
| Creates a new AI group for the given [[Side]]. An HQ (center) for that side must already be in the Mission.sqm or have been initialized with [[createCenter]]. For the available sides see [[Side]]. Since Arma 3 v 1.67 it is possible to mark created group for automatic deletion when the group becomes empty (see Alt Syntax)
<br><br>
<br><br>
'''NOTE''': The default limit of groups created per side was 144. Since Arma 3 v1.67 it is increased to 288.
'''NOTES'''  
* The default limit of groups created per side was 144. Since Arma 3 v1.67 it is increased to 288.
* When group is set to be automatically deleted when empty, when group becomes empty it may take up to a minute for it to get deleted.


{{Feature arma3|In Arma 3 when last unit leaves a group, the group gets auto deleted.}} |= Description
{{Feature arma3|In Arma 3 when last unit leaves its group, the group usually gets immediately auto deleted, regardless of whether or not if it was set for auto deletion manually}} |= Description
____________________________________________________________________________________________
____________________________________________________________________________________________


Line 21: Line 23:


| [[Group]] |= Return value
| [[Group]] |= Return value
|  s2='''createGroup''' [side, deleteWhenEmpty] &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;(''since Arma 3 v1.67'') |= Syntax
|p21=  [side, deleteWhenEmpty]: [[Array]] |= Parameter 1
|p22= side: [[Side]] |= Parameter 2
|p23= deleteWhenEmpty: [[Boolean]] - [[true]] if delete this group when empty. Default: [[false]] (Note that it may take up to a minute for the group to get deleted) |= Parameter 3
|r2= [[Group]] |= Return value
____________________________________________________________________________________________
____________________________________________________________________________________________
   
   
|x1= <code>_group <nowiki>=</nowiki> '''createGroup''' [[east]]</code> |= Example 1
|x1= <code>_group = '''createGroup''' [[east]]</code> |= Example 1
|x2= <code>_group = '''createGroup''' <nowiki>[</nowiki>[[east]], [[true]]];</code> |= Example 1
____________________________________________________________________________________________
____________________________________________________________________________________________


| [[deleteGroup]], [[group]], [[setGroupId]], [[groupID]], [[units]], [[groupFromNetId]], [[netId]], [[leader]], [[selectLeader]], [[join]], [[createCenter]], [[createUnit]], [[createVehicle]], [[Side]] |= See also
| [[deleteGroup]], [[deleteGroupWhenEmpty]], [[isGroupDeletedWhenEmpty]], [[group]], [[setGroupId]], [[groupID]], [[units]], [[groupFromNetId]], [[netId]], [[leader]], [[selectLeader]], [[join]], [[createCenter]], [[createUnit]], [[createVehicle]], [[Side]] |= See also


}}
}}

Revision as of 17:55, 6 January 2017

-wrong parameter ("Arma") defined!-1.00
GEGlobal
Hover & click on the images for description

Description

Description:
Creates a new AI group for the given Side. An HQ (center) for that side must already be in the Mission.sqm or have been initialized with createCenter. For the available sides see Side. Since Arma 3 v 1.67 it is possible to mark created group for automatic deletion when the group becomes empty (see Alt Syntax)

NOTES
  • The default limit of groups created per side was 144. Since Arma 3 v1.67 it is increased to 288.
  • When group is set to be automatically deleted when empty, when group becomes empty it may take up to a minute for it to get deleted.
Arma 3
In Arma 3 when last unit leaves its group, the group usually gets immediately auto deleted, regardless of whether or not if it was set for auto deletion manually
Groups:
Uncategorised

Syntax

Syntax:
createGroup side
Parameters:
side: Side
Return Value:
Group

Alternative Syntax

Syntax:
createGroup [side, deleteWhenEmpty]        (since Arma 3 v1.67)
Parameters:
[side, deleteWhenEmpty]: Array
side: Side
deleteWhenEmpty: Boolean - true if delete this group when empty. Default: false (Note that it may take up to a minute for the group to get deleted)
Return Value:
Group

Examples

Example 1:
_group = createGroup east
Example 2:
_group = createGroup [east, true];

Additional Information

See also:
deleteGroupdeleteGroupWhenEmptyisGroupDeletedWhenEmptygroupsetGroupIdgroupIDunitsgroupFromNetIdnetIdleaderselectLeaderjoincreateCentercreateUnitcreateVehicleSide

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 December 15, 2006 - 21:30
ColonelSandersLite

The group limit is 144 groups groups per side. If you attempt to create a group, and there is no room for another, it simply doesn't create, and it doesn't error.
Posted on July 10,2007
5133p39
In Armed Assault, empty groups are not automatically deleted - if you created 144 groups, you will not be able to create new group even if all units in all those groups died, because all the 144 groups still exists - you will have to delete some groups manually.
Posted on January 04, 2011
kju
A group created with createGroup will get a waypoint at [0,0,0]. When you use createUnit to fill it with units, it will get an additional waypoint at the position the first unit is created. This new waypoint will also be set as currentWaypoint. However keep these two waypoints in mind when you do some scripting involving this groups' waypoints.

Bottom Section

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