Page tree
Skip to end of metadata
Go to start of metadata



Introduced in

Version:3.5

Description

Description:Returns all subordinate groups of the given group.

Syntax

Syntax:grpAllGroups grp
Parameters:
  • grp: Group - Group to check.
Return Value:Array of Group - All subordinated groups, direct and indirect ones (returns an empty array, if no subordinate groups exist).

Examples

Examples:
_subGrps = grpAllGroups (group player)

For the example above, the following values would be returned:

  • CO: [1PL,1PL HQ,1PL 1SQ,1PL 2SQ,CO HQ,2PL,2PL HQ,2PL 1SQ,2PL 2SQ]
  • CO HQ: []
  • 2PL: [2PL HQ,2PL 1SQ,2PL 2SQ]
  • 2PL HQ: []
  • 2PL 1SQ: []
  • 2PL 2SQ: []
  • 1PL: [1PL HQ,1PL 1SQ,1PL 2SQ]
  • 1PL HQ: []
  • 1PL 1SQ: []
  • 1PL 2SQ: []

Additional Information

See also: groups, grpAllUnits, allGroups, group
Multiplayer: 
Problems: 

Notes