setGroupId

From Bohemia Interactive Community
Revision as of 07:40, 9 January 2021 by Lou Montana (talk | contribs) (Text replacement - "\[\[Category:[ _]?Scripting[ _]Commands[ _]Arma[ _]3(\|.*)\]\]" to "{{GameCategory|arma3|Scripting Commands}}")
Jump to navigation Jump to search
Hover & click on the images for description

Description

Description:
Sets the group radio callsign, how it will be displayed in radio chat. Two groups on the same side cannot have the same callsign (different side is possible). When trying to apply the same callsign to two groups of the same side, the callsigns will simply be swapped, e.g: group1 setGroupId ["Active Group"]; group2 setGroupId ["Inactive Group"]; group2 setGroupId ["Active Group"]; // group1 is "Inactive Group" now The identity setup can also consist of format keywords (marked with %) and param keywords taken from CfgWorlds config. Basically it is like format command but with some special group keywords (See Example 2).
Arma 3
Possible Arma 3 values:

%GroupSquad:

  • "Squad1" → 1
  • "Squad2" → 2
  • "Squad3" → 3
  • "Squad4" → 4

%GroupPlatoon:

  • "Platoon1" → 1
  • "Platoon2" → 2
  • "Platoon3" → 3
  • "Platoon4" → 4

%GroupCompany:

  • "CompanyAlpha" → Alpha
  • "CompanyBravo" → Bravo
  • "CompanyCharlie" → Charlie
  • "CompanyDelta" → Delta
  • "CompanyEcho" → Echo
  • "CompanyFoxtrot" → Foxtrot
  • "CompanyGolf" → Golf
  • "CompanyHotel" → Hotel
  • "CompanyIndia" → India
  • "CompanyKilo" → Kilo
  • "CompanyLima" → Lima
  • "CompanyMike" → Mike
  • "CompanyNovember" → November
  • "CompanyOscar" → Oscar
  • "CompanyPapa" → Papa
  • "CompanyQuebec" → Quebec
  • "CompanyRomeo" → Romeo
  • "CompanySierra" → Sierra
  • "CompanyTango" → Tango
  • "CompanyUniform" → Uniform
  • "CompanyVictor" → Victor
  • "CompanyWhiskey" → Whiskey
  • "CompanyXray" → X-Ray
  • "CompanyYankee" → Yankee
  • "CompanyZulu" → Zulu

%GroupNames:

  • "Alpha" → Alpha
  • "Bravo" → Bravo
  • "Charlie" → Charlie
  • "Delta" → Delta
  • "Echo" → Echo
  • "Foxtrot" → Foxtrot
  • "Golf" → Golf
  • "Hotel" → Hotel
  • "November" → November
  • "Kilo" → Kilo
  • "Yankee" → Yankee
  • "Zulu" → Zulu
  • "Two" → Two
  • "Three" → Three
  • "Buffalo" → Buffalo
  • "Guardian" → Guardian
  • "Convoy" → Convoy
  • "Fox" → Fox

%GroupColors:

  • "GroupColor0" → (nothing)
  • "GroupColor1" → Black
  • "GroupColor2" → Red
  • "GroupColor3" → Green
  • "GroupColor4" → Blue
  • "GroupColor5" → Yellow
  • "GroupColor6" → Orange
  • "GroupColor7" → Pink
  • "Six" → Six
↑ Back to spoiler's top
From Armed Assault, you can freely decide the callsign, e.g group player setGroupId ["First Assault Recon Team"];.
In Operation Flashpoint, group ID cannot be freely decided and format must be of [letter, colour, picture] or [letter, colour]. Possible values:

Letter:

  • "Alpha"
  • "Bravo"
  • "Charlie"
  • "Delta"
  • "Echo"
  • "Foxtrot"
  • "Golf"
  • "Hotel"
  • "Kilo"
  • "Yankee"
  • "Zulu"
  • "Buffalo"
  • "Convoy"
  • "Guardian"
  • "November"
  • "Two"
  • "Three"
  • "Fox"

Colour:

  • "GroupColor0" → (nothing)
  • "GroupColor1" → Black
  • "GroupColor2" → Red
  • "GroupColor3" → Green
  • "GroupColor4" → Blue
  • "GroupColor5" → Yellow
  • "GroupColor6" → Orange
  • "GroupColor7" → Pink
  • "Six" → Six
↑ Back to spoiler's top
The radio callsign strings can be overwritten in a mission by writing Stringtable entries of the same name. Some entry names:
  • STR_CFG_GRPNAMES_ALPHA
  • STR_CFG_GRPNAMES_FOX
  • STR_CFG_GRPCOL_BLACK
  • STR_CFG_GRPNAMES_SIX (unlike its name suggests, this is a "group colour")
  • STR_CFG_FIREFLYBASE
  • STR_CFG_PAPABEAR
  • STR_CFG_HQ_BASE
For the global variant of this command see setGroupIdGlobal.
Groups:
Groups

Syntax

Syntax:
group setGroupId [nameFormat, nameParam1, ..., nameParamN]
Parameters:
group: Object or Group
[nameFormat, nameParam1, ..., nameParamN]: Array
nameFormat: String - format template (%keyword1 - %keyword2...etc)
nameParam1: String - param keyword
Return Value:
Nothing

Examples

Example 1:
Arma 3:group player setGroupId ["Some name for the group"]; hint groupId group player; // "Some name for the group" player sideChat "lalala"; // Some name for the group (KK): "lalala"
Example 2:
Arma 3:group player setGroupId ["%GroupNames :=: %GroupColors", "Alpha", "GroupColor2"]; hint groupId group player; // "Alpha :=: Red" player sideChat "lalala"; // Alpha :=: Red (KK): "lalala"
Example 3:
ArmA / Arma 2 / Arma 3: _group1 setGroupId ["Assault Squad"];
Example 4:
OFP: _group1 setGroupId ["Delta", "GroupColor4"]

Additional Information

See also:
setGroupIdGlobalgroupIdgroup

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

Notes

Posted on April 21, 2015 - 23:21 (UTC)
Killzone Kid
List of available keywords from config: "if ((configName _x) select [0, 5] == 'group') then { diag_log ('%' + configName _x); for '_i' from 0 to count _x - 1 do { diag_log ('* ""' + configName (_x select _i) + '"" → ' + getText ((_x select _i) >> 'name')); }; }; false" configClasses (configFile >> "CfgWorlds");

Bottom Section