Difference between revisions of "setGroupId"

From Bohemia Interactive Community
Jump to navigation Jump to search
(group id swap explained)
m (Text replacement - " |game1= ofp |version1= 1.00 |game2= arma1 |version2= 1.00 |game3= arma2 |version3= 1.00 |game4= arma2oa |version4= 1.51 |game5= tkoh |version5= 1.00 |game6= arma3 |version6= 0.50 " to " |game1= ofp |version1= 1.00 |game...)
 
(41 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{Command|= Comments
+
{{RV|type=command
____________________________________________________________________________________________
 
  
| ofp |= Game name
+
|game1= ofp
 +
|version1= 1.00
  
|1.00|= Game version
+
|game2= ofpe
 +
|version2= 1.00
  
|arg= global |= Arguments in MP
+
|game3= arma1
 +
|version3= 1.00
  
|eff= local |= Effects in MP
+
|game4= arma2
____________________________________________________________________________________________
+
|version4= 1.00
  
| 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:
+
|game5= arma2oa
<code>group1 <nowiki>=</nowiki> [[createGroup]] [[west]];
+
|version5= 1.50
group2 <nowiki>=</nowiki> [[createGroup]] [[west]];
 
  
group1 [[setGroupId]] ["Active Group"];
+
|game6= tkoh
group2 [[setGroupId]] ["Inactive Group"];
+
|version6= 1.00
  
[[systemChat]] [[groupId]] group1; //"Active Group";
+
|game7= arma3
[[systemChat]] [[groupId]] group2; //"Inactive Group";
+
|version7= 0.50
  
group2 [[setGroupId]] ["Active Group"];
+
|gr1= Groups
  
[[systemChat]] [[groupId]] group1; //"Inactive Group";
+
|arg= global
[[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:
+
|eff= local
<br><br>
 
%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]].
+
|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 (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:
|= Description
+
<code>group1 [[setGroupId]] ["Active Group"];
____________________________________________________________________________________________
+
group2 [[setGroupId]] ["Inactive Group"];
 +
group2 [[setGroupId]] ["Active Group"]; {{cc|group1 is "Inactive Group" now}}</code>
  
| group '''setGroupId''' [nameFormat, nameParam1, ..., nameParamN] |= Syntax
+
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).
  
|p1= group: [[Object]] or [[Group]] |= Parameter 1
+
{{Feature|arma3 | Possible {{arma3}} values: <spoiler>
 +
'''%GroupSquad''':
 +
* "Squad1" → 1
 +
* "Squad2" → 2
 +
* "Squad3" → 3
 +
* "Squad4" → 4
  
|p2= [nameFormat, nameParam1, ..., nameParamN]: [[Array]] |= Parameter 2
+
'''%GroupPlatoon''':
|p3= nameFormat: [[String]] - format template (%keyword1 - %keyword2...etc) |= Parameter 2
+
* "Platoon1" → 1
|p4= nameParam1: [[String]] - param keyword |= Parameter 2
+
* "Platoon2" → 2
 +
* "Platoon3" → 3
 +
* "Platoon4" → 4
  
| [[Nothing]] |= Return value
+
'''%GroupCompany''':
____________________________________________________________________________________________
+
* "CompanyAlpha" → Alpha
|x1= '''Arma 3''':<code>[[group]] [[player]] [[setGroupId]] ["Some name for the group"];
+
* "CompanyBravo" → Bravo
[[hint]] [[groupId]] [[group]] [[player]]; //"Some name for the group"
+
* "CompanyCharlie" → Charlie
[[player]] [[sideChat]] "lalala"; //Some name for the group (KK): "lalala"</code>|= Example1  
+
* "CompanyDelta" → Delta
|x2= '''Arma 3''':<code>[[group]] [[player]] [[setGroupId]] ["%GroupNames :=: %GroupColors","Alpha","GroupColor2"];
+
* "CompanyEcho" → Echo
[[hint]] [[groupId]] [[group]] [[player]]; //"Alpha :=: Red"
+
* "CompanyFoxtrot" → Foxtrot
[[player]] [[sideChat]] "lalala"; //Alpha :=: Red (KK): "lalala"</code>|= Example 2
+
* "CompanyGolf" → Golf
|x3= '''OFP''':<code>_group1 [[setGroupId]] ["Delta","GroupColor4"]</code> |= Example 3
+
* "CompanyHotel" → Hotel
|x4= '''ArmA / ArmA 2''':<code>_group1 [[setGroupId]] ["Assault Squad"]</code> |= Example 4
+
* "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
  
| [[setGroupIdGlobal]], [[groupId]], [[group]] |= See also
+
'''%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
 +
</spoiler>}}
 +
{{Feature | Informative | Since '''{{arma1}}''', you can freely decide the callsign, e.g {{ic| [[group]] [[player]] [[setGroupId]] ["First Assault Recon Team"];}}.}}
 +
{{Feature | Informative | In '''{{ofp}}''', group ID cannot be freely decided and format must be of [letter, colour, picture] or [letter, colour]. Possible values: <spoiler>
 +
'''Letter:'''
 +
* "Alpha"
 +
* "Bravo"
 +
* "Charlie"
 +
* "Delta"
 +
* "Echo"
 +
* "Foxtrot"
 +
* "Golf"
 +
* "Hotel"
 +
* "Kilo"
 +
* "Yankee"
 +
* "Zulu"
 +
* "Buffalo"
 +
* "Convoy"
 +
* "Guardian"
 +
* "November"
 +
* "Two"
 +
* "Three"
 +
* "Fox"
  
<h3 style="display:none">Notes</h3>
+
'''Colour:'''
<dl class="command_description">
+
* "GroupColor0" → (nothing)
<!-- Note Section BEGIN -->
+
* "GroupColor1" → Black
<dd class="notedate">
+
* "GroupColor2" → Red
<dd class="note">In '''OFP''', group ID format must be [letter, color, picture] or [letter, color].
+
* "GroupColor3" → Green
 +
* "GroupColor4" → Blue
 +
* "GroupColor5" → Yellow
 +
* "GroupColor6" → Orange
 +
* "GroupColor7" → Pink
 +
* "Six" → Six
 +
</spoiler>
 +
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'''
 +
* 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</spoiler>}}
  
Letter is one of:
+
|mp= For the global variant of this command see [[setGroupIdGlobal]].
* '''"Alpha"'''
 
* '''"Bravo"'''
 
* '''"Charlie"'''
 
* '''"Delta"'''
 
* '''"Echo"'''
 
* '''"Foxtrot"'''
 
* '''"Golf"'''
 
* '''"Hotel"'''
 
* '''"Kilo"'''
 
* '''"Yankee"'''
 
  
* '''"Zulu"'''
+
|s1= group [[setGroupId]] [nameFormat, nameParam1, ..., nameParamN]
* '''"Buffalo"'''
 
* '''"Convoy"'''
 
* '''"Guardian"'''
 
* '''"November"'''
 
* '''"Two"'''
 
* '''"Three"'''
 
* '''"Fox"'''
 
  
Colour may be one of the following:
+
|p1= group: [[Object]] or [[Group]]
* '''"GroupColor0"''' - (Nothing)
 
* '''"GroupColor1"''' - Black
 
* '''"GroupColor2"''' - Red
 
* '''"GroupColor3"''' - Green
 
* '''"GroupColor4"''' - Blue
 
* '''"GroupColor5"''' - Yellow
 
* '''"GroupColor6"''' - Orange
 
* '''"GroupColor7"''' - Pink
 
* '''"Six"''' - Six
 
<dd class="notedate">Posted on August 4, 2006 - 11:01
 
<dt class="note">'''[[User:Hardrock|hardrock]]'''<dd class="note">''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]]:
+
|p2= [nameFormat, nameParam1, ..., nameParamN]: [[Array]]
  
grp1 <nowiki>=</nowiki> [[group]] this
+
|p3= nameFormat: [[String]] - format template (%keyword1 - %keyword2...etc)
  
 +
|p4= nameParam1: [[String]] - param keyword
  
<dd class="notedate">Posted on December 9, 2006 - 12:20
+
|r1= [[Nothing]]
<dt class="note">'''[[User:Mondkalb|Mondkalb]]'''<dd class="note">''Selfdefined Callsigns:''
 
  
In [[Armed Assault]] you're able to define the callsignletter by yourself. This can be for example "Fireteam", or "Specialforces".
+
|x1= '''{{arma3}}''':<code>[[group]] [[player]] [[setGroupId]] ["Some name for the group"];
 +
[[hint]] [[groupId]] [[group]] [[player]]; {{cc|"Some name for the group"}}
 +
[[player]] [[sideChat]] "lalala"; {{cc|Some name for the group (KK): "lalala"}}</code>
  
this setgroupId ["Attackteam"]
+
|x2= '''{{arma3}}''':<code>[[group]] [[player]] [[setGroupId]] ["%GroupNames :{{=}}: %GroupColors", "Alpha", "GroupColor2"];
 +
[[hint]] [[groupId]] [[group]] [[player]]; {{cc|"Alpha :{{=}}: Red"}}
 +
[[player]] [[sideChat]] "lalala"; {{cc|Alpha :{{=}}: Red (KK): "lalala"}}</code>
  
<dd class="notedate">
+
|x3= '''{{arma1}} / {{arma2}} / {{arma3}}''': <code>_group1 [[setGroupId]] ["Assault Squad"];</code>
<dt class="note">'''[[User:Ceeeb|Ceeeb]]'''
 
<dd class="note">
 
In '''OFP v1.96''', the radio callsign strings for a mission can be redefined  by creating a [[Stringtable.csv_File_Format|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.
 
  
 +
|x4= '''{{ofp}}''': <code>_group1 [[setGroupId]] ["Delta", "GroupColor4"]</code>
  
<!-- Note Section END -->
+
|seealso= [[setGroupIdGlobal]], [[groupId]], [[group]]
</dl>
+
}}
  
<h3 style="display:none">Bottom Section</h3>
 
 
 
[[Category:Scripting Commands|SETGROUPID]]
 
[[Category:Scripting Commands OFP 1.99|{{uc:{{PAGENAME}}}}]]
 
[[Category:Scripting Commands OFP 1.96|SETGROUPID]]
 
[[Category:Scripting Commands OFP 1.46|SETGROUPID]]
 
[[Category:Scripting Commands ArmA|SETGROUPID]]
 
[[Category:Scripting Commands ArmA2|{{uc:{{PAGENAME}}}}]]
 
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
 
[[Category:Scripting_Commands_Take_On_Helicopters|{{uc:{{PAGENAME}}}}]]
 
[[Category:Command_Group:_Groups|{{uc:{{PAGENAME}}}}]]
 
[[Category:Command_Group:_Object_Manipulation|{{uc:{{PAGENAME}}}}]]
 
 
<!-- CONTINUE Notes -->
 
 
<dl class="command_description">
 
<dl class="command_description">
 +
<dt><dt>
 
<dd class="notedate">Posted on April 21, 2015 - 23:21 (UTC)</dd>
 
<dd class="notedate">Posted on April 21, 2015 - 23:21 (UTC)</dd>
 
<dt class="note">[[User:Killzone Kid|Killzone Kid]]</dt>
 
<dt class="note">[[User:Killzone Kid|Killzone Kid]]</dt>
 
<dd class="note">
 
<dd class="note">
List of available keywords from config:<code>"if ((configName _x) select [0, 5] <nowiki>==</nowiki> 'group') then {
+
List of available keywords from config: <code>"[[if]] (([[configName]] _x) select [0, 5] == 'group') [[then]] {
diag_log ('%' + configName _x);
+
[[diag_log]] ('%' + [[configName]] _x);
for '_i' from 0 to count _x - 1 do {
+
[[for]] '_i' [[from]] 0 [[to]] [[count]] [[Magic Variables#x|_x]] - 1 [[do]] {
diag_log ('* ""' + configName (_x select _i) + '"" -> ' + getText ((_x select _i) >> 'name'));
+
[[diag_log]] ('* ""' + [[configName]] (_x [[select]] _i) + '"" ' + [[getText]] (([[Magic Variables#x|_x]] [[select]] _i) >> 'name'));
 
};
 
};
}; false" configClasses (configFile >> "CfgWorlds");</code>
+
}; [[false]]" [[configClasses]] ([[configFile]] >> "CfgWorlds");</code>
 
</dd>
 
</dd>
 +
 
</dl>
 
</dl>
<!-- DISCONTINUE Notes -->
+
 
 +
 
 +
[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]
 +
{{GameCategory|arma1|Scripting Commands}}
 +
{{GameCategory|arma2|Scripting Commands}}
 +
{{GameCategory|arma3|Scripting Commands}}
 +
{{GameCategory|tkoh|Scripting Commands}}

Latest revision as of 23:38, 12 April 2021

Hover & click on the images for descriptions

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: Show text
Since 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: Show text

The radio callsign strings can be overwritten in a mission by writing Stringtable entries of the same name. Some entry names: Show text

Multiplayer:
For the global variant of this command see setGroupIdGlobal.

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:
Armed Assault / Arma 2 / Arma 3: _group1 setGroupId ["Assault Squad"];
Example 4:
Operation Flashpoint: _group1 setGroupId ["Delta", "GroupColor4"]

Additional Information

See also:
setGroupIdGlobalgroupIdgroup
Groups:
Groups

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