createGroup

Description

Creates a new Group for the given Side. Using this command if the group limit is reached will return grpNull. The new Group exists globally, but it's locality is where this command was executed.

Important

• 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)

Note

Arma 3:

• 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.

Syntax

Syntax 1

createGroup side

Parameters:

• side: Side

Returns: Group - grpNull if the group limit is reached

Syntax 2

since arma3 1.68

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.

Returns: Group - grpNull if the group limit is reached

Examples

Example 1

private _group = createGroup east;

Example 2

private _group = createGroup [east, true];

See also

deleteGroup · deleteGroupWhenEmpty · isGroupDeletedWhenEmpty · group · setGroupId · groupID · units · groupFromNetId · netId · leader · selectLeader · join · createCenter · createUnit · createVehicle · Side

player addAction ["Group Test (Dedicated Server)", {
    [[], {
        _test = createGroup [west, true];
        [str (local _test)] remoteExec ["hint", -2]; //tell all clients group locality; true
        missionNamespace setVariable ["Group_Reference", _test, true]; //broadcast group reference to all players
    }] remoteExec ["call", 2]; //create group on dedicated server only
    sleep 1;
    _newGroup = missionNamespace getVariable "Group_Reference"; //receive group reference from server
    systemChat format ["Group local to player: %1", local _newGroup]; //false
}];