createGroup

1.001.001.001.501.000.50

GEGlobal

Hover & click on the images for description

Description

Description:

Creates a new Group for the given Side. Using this command if the group limit is reached will return grpNull.

Game	1.00	1.00	1.00	1.00	1.50	1.00	1.00	1.68
Group auto-deletion
Group limit per side	63	144						288

⚠

• Groups can only be created for the west/blufor, opfor/east, independent/resistance, civilian and sideLogic sides - any other side will return grpNull
• Before Arma 3, a Side center must exist before group creation (either by having editor-placed units or createCenter usage)

• createCenter usage is not needed anymore as all centers are automatically created.
• When the last unit leaves its group, the group usually gets immediately auto-deleted, regardless of its auto-deletion setting.

Groups:

Groups

Syntax

Syntax:

createGroup side

Parameters:

side: Side

Return Value:

Group - grpNull if the group limit is reached

1.68

Alternative Syntax

Syntax:

createGroup [side, deleteWhenEmpty]

Parameters:

side: Side

deleteWhenEmpty: Boolean - true to delete the group when empty.

• If set to true, forces a group to get deleted when empty - it does not prevent its deletion by other commands when set to false.
• Deletion may take up to a minute after the last unit is removed.

Return Value:

Group - grpNull if the group limit is reached

Examples

Example 1:

private _group = createGroup east;

Example 2:

private _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

kju - c

Posted on Jan 04, 2011 - 10:19 (UTC)

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.