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


Introduced in

Version:1.00

Description

Description:Sets the group formation. Can be:
  • "": Keep current formation
  • "COLUMN"
  • "STAG COLUMN"
  • "WEDGE"
  • "ECH LEFT"
  • "ECH RIGHT"
  • "VEE"
  • "LINE"
  • "FILE"
  • "DIAMOND"

Formations can only be selected in behaviour "AWARE" and higher (weapon raised). For "CARELESS" and "SAFE" modes, AI units always move in column formation.

Affects the whole interlinked (ORBAT) hierarchy, even if called on a sub-group. Other groups are set according to previous settings (according to what formation returns).

Syntax

Syntax:grp setFormation formation
Parameters:
  • grp: Group - Group to which formation settings are applied.
  • formation: String - Formation name (as listed in description).
Return Value:Nothing

Alternative Syntax

Syntax:grp setFormation [formation, teleport] (V3.7+)
Parameters:
  • grp: Group - Group to which formation settings are applied.
  • formation: String - Formation name (as listed in description). Use "" to teleport into setCustomFormation (which have been assigned in a previously frame).
  • teleport: Boolean - If true, then group members are teleported immediately to the new position. If false, then they walk there, like in the standard command syntax.
Return Value:Nothing

Examples

Examples:
Sets the group formation to a line:
groupOne setFormation "LINE";

Teleport group members to their position:
groupOne setFormation ["LINE", true];

Additional Information

See also: setMaintainFormation, setCustomFormation
Multiplayer:
Problems:

Notes