createGroup
Jump to navigation
Jump to search
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.
- 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 Arma, 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
Categories:
- Scripting Commands
- Introduced with Arma version 1.00
- Arma: New Scripting Commands
- Arma: Scripting Commands
- Command Group: Uncategorised
- Scripting Commands: Global Effect
- Scripting Commands OFP Elite
- Scripting Commands ArmA
- Scripting Commands ArmA2
- Scripting Commands Arma 3
- Scripting Commands Take On Helicopters
- Command Group: Groups
- Command Group: Object Manipulation