setGroupId: Difference between revisions

Revision as of 17:43, 4 January 2023

1.00

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 (possible on different sides) - see Example 4.
The identity setup can consist of format keywords (marked with %) and param keywords taken from CfgWorlds config. Formatting is almost like using the format command but with some special group keywords (see Example 2).

%GroupSquad	%GroupPlatoon	%GroupCompany	%GroupNames	%GroupColors
"Squad1" → 1 "Squad2" → 2 "Squad3" → 3 "Squad4" → 4	"Platoon1" → 1 "Platoon2" → 2 "Platoon3" → 3 "Platoon4" → 4	"CompanyAlpha" → Alpha "CompanyBravo" → Bravo "CompanyCharlie" → etc. "CompanyDelta" "CompanyEcho" "CompanyFoxtrot" "CompanyGolf" "CompanyHotel" "CompanyIndia" "CompanyKilo" "CompanyLima" "CompanyMike" "CompanyNovember" "CompanyOscar" "CompanyPapa" "CompanyQuebec" "CompanyRomeo" "CompanySierra" "CompanyTango" "CompanyUniform" "CompanyVictor" "CompanyWhiskey" "CompanyXray" → X-Ray "CompanyYankee" "CompanyZulu"	"Alpha" "Bravo" "Charlie" "Delta" "Echo" "Foxtrot" "Golf" "Hotel" "November" "Kilo" "Yankee" "Zulu" "Convoy" "Buffalo" "Guardian" "Two" "Three" "Fox"	"GroupColor0" → (nothing) "GroupColor1" → Black "GroupColor2" → Red "GroupColor3" → Green "GroupColor4" → Blue "GroupColor5" → Yellow "GroupColor6" → Orange "GroupColor7" → Pink "Six" → Six

↑ Back to spoiler's top

Letter	Colour
"Alpha" "Bravo" "Charlie" "Delta" "Echo" "Foxtrot" "Golf" "Hotel" "Kilo" "Yankee" "Zulu" "Buffalo" "Convoy" "Guardian" "November" "Two" "Three" "Fox"	"GroupColor0" → (nothing) "GroupColor1" → Black "GroupColor2" → Red "GroupColor3" → Green "GroupColor4" → Blue "GroupColor5" → Yellow "GroupColor6" → Orange "GroupColor7" → Pink "Six" → Six

↑ Back to spoiler's top

In Operation Flashpoint, the group ID cannot be freely decided and format must be [letter, colour, picture] or [letter, colour] - nameFormat cannot be a custom text - see Example 3.
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

Multiplayer:

For the global variant of this command see setGroupIdGlobal.

Groups:

Groups

Syntax

Syntax:: group setGroupId [nameFormat, nameParam1, ..., nameParamN]
Parameters:: group: Object or Group
: 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:: Armed Assault / Arma 2 / Arma 3:
group player setGroupId ["First Assault Recon Team"];
Operation Flashpoint:
_group1 setGroupId ["Delta", "GroupColor4"]
Example 5:: 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

Additional Information

See also:: setGroupIdGlobal groupId group

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

Killzone Kid - c: Posted on Apr 21, 2015 - 23:21 (UTC)
: ⓘ
Extraction script can be found on the Biki Export Scripts page.

@@ Line 28: / Line 28: @@
 |eff= local
-|descr= Sets the group radio callsign, how it will be displayed in radio chat. Two groups on the same side '''cannot''' have the same callsign (possible on different sides) - see {{HashLink|#Example 4}}.<br>
+|descr= Sets the group radio callsign, how it will be displayed in radio chat. Two groups on the same side '''cannot''' have the same callsign (possible on different sides) - see {{Link|#Example 4}}.<br>
 The identity setup can consist of format keywords (marked with '''%''') and param keywords taken from '''CfgWorlds''' config.
-Formatting is almost like using the [[format]] command but with some special group keywords (see {{HashLink|#Example 2}}).
+Formatting is almost like using the [[format]] command but with some special group keywords (see {{Link|#Example 2}}).
 <br>
 <spoiler text="Show Arma 3 values table">
@@ Line 150: / Line 150: @@
 </spoiler>
 {{Feature | ofp |
-* In '''{{ofp}}''', the group ID cannot be freely decided and format must be [letter, colour, picture] or [letter, colour] - ''nameFormat'' '''cannot''' be a custom text - see {{HashLink|#Example 3}}.
+* In '''{{ofp}}''', the group ID cannot be freely decided and format must be [letter, colour, picture] or [letter, colour] - ''nameFormat'' '''cannot''' be a custom text - see {{Link|#Example 3}}.
 * The radio callsign strings can be overwritten in a mission by writing [[Stringtable.csv|Stringtable]] entries of the same name. Some entry names: <spoiler>
 * STR_CFG_''GRPNAMES''_'''ALPHA'''