setGroupId

From Bohemia Interactive Community
Revision as of 15:29, 17 April 2006 by Planck (talk | contribs)
Jump to navigation Jump to search
The printable version is no longer supported and may have rendering errors. Please update your browser bookmarks and please use the default browser print function instead.

back to COMREF

group setGroupId id


Operand types:

group: Object or Group

id: Array

Type of returned value:

Nothing

Description:

Set group identity.

Id format is [letter, color, picture] or [letter, color].
Letter is one of:

  • "Alpha"
  • "Bravo"
  • "Charlie"
  • "Delta"
  • "Echo"
  • "Foxtrot"
  • "Golf"
  • "Hotel"
  • "Kilo"

Colour can be one of "GroupColor0" to "GroupColor7".


Example:

group1 setGroupId ["Delta","GroupColor4"]


Comments:

Additional values for letter are:

  • "Yankee"
  • "Zulu"
  • "Buffalo"
  • "Convoy"
  • "Guardian"
  • "November"
  • "Two"
  • "Three"

Color can also be set to "Six".

Following is a list of GroupColors:

  • 0 - No colour
  • 1 - Black
  • 2 - Red
  • 3 - Green
  • 4 - Blue
  • 5 - Yellow
  • 6 - Orange
  • 7 - Pink

Note that this does not name the group.

To call a group "grp1", for example, write this in the init field of the group leader:

grp1 = group this