setGroupId: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
(example)
(group id swap explained)
Line 11: Line 11:
____________________________________________________________________________________________
____________________________________________________________________________________________


| Sets a group's identity, how it will be displayed in chat, for example. The identity setup consists of format keywords (marked with %) and param keywords taken from CfgWorlds config. Basically it is like [[format]] command but with some special group keywords. For Arma 3 possible values are:
| Sets a group's identity, how it will be displayed in chat, for example. While groups on the different [[Side|sides]] can have identical ids, the groups on the same [[side]] cannot. When given id exists already, the group which currently has it will simply swap it with the current id of the group for which this id is intended. For example:
<code>group1 <nowiki>=</nowiki> [[createGroup]] [[west]];
group2 <nowiki>=</nowiki> [[createGroup]] [[west]];
 
group1 [[setGroupId]] ["Active Group"];
group2 [[setGroupId]] ["Inactive Group"];
 
[[systemChat]] [[groupId]] group1; //"Active Group";
[[systemChat]] [[groupId]] group2; //"Inactive Group";
 
group2 [[setGroupId]] ["Active Group"];
 
[[systemChat]] [[groupId]] group1; //"Inactive Group";
[[systemChat]] [[groupId]] group2; //"Active Group";</code>
 
The identity setup could 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. For Arma 3 possible values are:
<br><br>
<br><br>
%GroupSquad
%GroupSquad
Line 93: Line 108:
| [[Nothing]] |= Return value
| [[Nothing]] |= Return value
____________________________________________________________________________________________
____________________________________________________________________________________________
 
|x1= '''Arma 3''':<code>[[group]] [[player]] [[setGroupId]] ["Some name for the group"];
|x1= '''Arma 3''':<code>[[group]] [[player]] [[setGroupId]] ["%GroupNames :=: %GroupColors","Alpha","GroupColor2"];
[[hint]] [[groupId]] [[group]] [[player]]; //"Some name for the group"
[[player]] [[sideChat]] "lalala"; //Some name for the group (KK): "lalala"</code>|= Example1  
|x2= '''Arma 3''':<code>[[group]] [[player]] [[setGroupId]] ["%GroupNames :=: %GroupColors","Alpha","GroupColor2"];
[[hint]] [[groupId]] [[group]] [[player]]; //"Alpha :=: Red"
[[hint]] [[groupId]] [[group]] [[player]]; //"Alpha :=: Red"
[[player]] [[sideChat]] "lalala"; //Alpha :=: Red (KK): "lalala"</code>|= Example 1
[[player]] [[sideChat]] "lalala"; //Alpha :=: Red (KK): "lalala"</code>|= Example 2
|x2= '''Arma 3''':<code>[[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"</code>|= Example 2
|x3= '''OFP''':<code>_group1 [[setGroupId]] ["Delta","GroupColor4"]</code> |= Example 3
|x3= '''OFP''':<code>_group1 [[setGroupId]] ["Delta","GroupColor4"]</code> |= Example 3
|x4= '''ArmA / ArmA 2''':<code>_group1 [[setGroupId]] ["Assault Squad"]</code> |= Example 4
|x4= '''ArmA / ArmA 2''':<code>_group1 [[setGroupId]] ["Assault Squad"]</code> |= Example 4

Revision as of 23:14, 26 June 2016

Hover & click on the images for description

Description

Description:
Sets a group's identity, how it will be displayed in chat, for example. While groups on the different sides can have identical ids, the groups on the same side cannot. When given id exists already, the group which currently has it will simply swap it with the current id of the group for which this id is intended. For example: group1 = createGroup west; group2 = createGroup west; group1 setGroupId ["Active Group"]; group2 setGroupId ["Inactive Group"]; systemChat groupId group1; //"Active Group"; systemChat groupId group2; //"Inactive Group"; group2 setGroupId ["Active Group"]; systemChat groupId group1; //"Inactive Group"; systemChat groupId group2; //"Active Group"; The identity setup could 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. For Arma 3 possible values are:

%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
  • "GroupColor1" -> Black
  • "GroupColor2" -> Red
  • "GroupColor3" -> Green
  • "GroupColor4" -> Blue
  • "GroupColor5" -> Yellow
  • "GroupColor6" -> Orange
  • "GroupColor7" -> Pink
  • "GroupColor0" ->
  • "Six" -> Six
For global variant of this command use setGroupIdGlobal.
Groups:
Uncategorised

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:
OFP:_group1 setGroupId ["Delta","GroupColor4"]
Example 4:
ArmA / ArmA 2:_group1 setGroupId ["Assault Squad"]

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

In OFP, group ID format must be [letter, color, picture] or [letter, color]. Letter is one of:
  • "Alpha"
  • "Bravo"
  • "Charlie"
  • "Delta"
  • "Echo"
  • "Foxtrot"
  • "Golf"
  • "Hotel"
  • "Kilo"
  • "Yankee"
  • "Zulu"
  • "Buffalo"
  • "Convoy"
  • "Guardian"
  • "November"
  • "Two"
  • "Three"
  • "Fox"
Colour may be one of the following:
  • "GroupColor0" - (Nothing)
  • "GroupColor1" - Black
  • "GroupColor2" - Red
  • "GroupColor3" - Green
  • "GroupColor4" - Blue
  • "GroupColor5" - Yellow
  • "GroupColor6" - Orange
  • "GroupColor7" - Pink
  • "Six" - Six
Posted on August 4, 2006 - 11:01
hardrock
Notes from before the conversion: Note that this command 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
Posted on December 9, 2006 - 12:20
Mondkalb
Selfdefined Callsigns: In Armed Assault you're able to define the callsignletter by yourself. This can be for example "Fireteam", or "Specialforces". this setgroupId ["Attackteam"]
Ceeeb
In OFP v1.96, the radio callsign strings for a mission can be redefined by creating a stringtable.csv in the mission folder. All string names except FOX can be found within the main stringtable.csv. Note "SIX" has a string suggesting it is a groupname, although the engine uses it as a colour. Some examples of the string names : STR_CFG_GRPNAMES_ALPHA, STR_CFG_GRPNAMES_FOX, STR_CFG_GRPCOL_BLACK, STR_CFG_GRPNAMES_SIX, STR_CFG_FIREFLYBASE, STR_CFG_PAPABEAR, STR_CFG_HQ_BASE, STR_CFG_HQ_BASE.

Bottom Section

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");