createGroup

From Bohemia Interactive Community
Jump to navigation Jump to search
Introduced with Armed Assault version 1.001.00Effects of this scripting command are broadcasted over the network and happen on every computer in the network
Hover & click on the images for descriptions

Description

Description:
Creates a new 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.

NOTES
  • The default limit of groups created per side was 144. Since Arma 3 v1.67 it is increased to 288.
  • Since Arma 3 v 1.67 it is possible to mark created group for automatic deletion when the group becomes empty (see Alt Syntax). 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 logo black.png
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
When true `deleteWhenEmpty` param can force a group to get deleted when empty, but cannot prevent a group from getting deleted when empty by other engine processes when false

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
Groups:
Groups

Notes

i
Only post proven facts here. Report bugs on the Feedback Tracker and discuss on the Arma Discord or on the Forums.

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

Posted on June 21, 2020 - 00:10 (UTC)
fusselwurm
Groups can only be created for east, west, civilian, independent and sideLogic . All other sides will return grpNull