Difference between revisions of "setGroupId"

From Bohemia Interactive Community
Jump to navigation Jump to search
m
m (Text replacement - "|version6= 0.50 " to "|version6= 0.50 ")
(73 intermediate revisions by 18 users not shown)
Line 1: Line 1:
[[Category:Scripting Commands|SETGROUPID]]
+
{{RV|type=command
[[Category:Scripting Commands OFP 1.97|SETGROUPID]]
 
[[Category:Scripting Commands OFP 1.46|SETGROUPID]]
 
[[Category:Scripting Commands ArmA|SETGROUPID]]
 
  
 +
|game1= ofp
  
<h2 style="color:#000066">'''''group'' setGroupId ''id'''''</h2>
+
|version1= 1.00
  
 +
|game2= arma1
  
'''Operand types:'''
+
|version2= 1.00
  
'''group:''' [[Object or Group]]
+
|game3= arma2
  
'''id:''' [[Array]]
+
|version3= 1.00
  
'''Type of returned value:'''
+
|game4= arma2oa
  
[[Nothing]]
+
|version4= 1.51
  
'''Description:'''
+
|game5= tkoh
  
Set '''group identity'''.
+
|version5= 1.00
  
'''Id''' format is '''''[letter, color, picture]''''' or '''''[letter, color]'''''.<br>
+
|game6= arma3
'''Letter''' is one of:
 
  
* '''"Alpha"'''
+
|version6= 0.50
* '''"Bravo"'''
 
* '''"Charlie"'''
 
* '''"Delta"'''
 
* '''"Echo"'''
 
* '''"Foxtrot"'''
 
* '''"Golf"'''
 
* '''"Hotel"'''
 
* '''"Kilo"'''
 
  
'''Colour''' can be one of "GroupColor0" to "GroupColor7".
+
|gr1= Groups
  
 +
|arg= global
  
'''Example:'''
+
|eff= local
  
group1 '''setGroupId''' ["Delta","GroupColor4"]
+
|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:
 +
<code>group1 [[setGroupId]] ["Active Group"];
 +
group2 [[setGroupId]] ["Inactive Group"];
 +
group2 [[setGroupId]] ["Active Group"]; {{cc|group1 is "Inactive Group" now}}</code>
  
 +
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).
  
'''Comments:'''
+
{{Feature|arma3 | Possible {{arma3}} values: <spoiler>
 +
'''%GroupSquad''':
 +
* "Squad1" → 1
 +
* "Squad2" → 2
 +
* "Squad3" → 3
 +
* "Squad4" → 4
  
Additional values for '''letter''' are:
+
'''%GroupPlatoon''':
 +
* "Platoon1" → 1
 +
* "Platoon2" → 2
 +
* "Platoon3" → 3
 +
* "Platoon4" → 4
  
* '''"Yankee"'''
+
'''%GroupCompany''':
* '''"Zulu"'''
+
* "CompanyAlpha" → Alpha
* '''"Buffalo"'''
+
* "CompanyBravo" → Bravo
* '''"Convoy"'''
+
* "CompanyCharlie" → Charlie
* '''"Guardian"'''
+
* "CompanyDelta" → Delta
* '''"November"'''
+
* "CompanyEcho" → Echo
* '''"Two"'''
+
* "CompanyFoxtrot" → Foxtrot
* '''"Three"'''
+
* "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
  
'''Color''' can also be set to '''"Six"'''.
+
'''%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
  
Following is a list of GroupColors:
+
'''%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 {{Inline code | [[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"
  
* '''0''' - No colour
+
'''Colour:'''
* '''1''' - Black
+
* "GroupColor0" → (nothing)
* '''2''' - Red
+
* "GroupColor1" → Black
* '''3''' - Green
+
* "GroupColor2" → Red
* '''4''' - Blue
+
* "GroupColor3" → Green
* '''5''' - Yellow
+
* "GroupColor4" → Blue
* '''6''' - Orange
+
* "GroupColor5" → Yellow
* '''7''' - Pink
+
* "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>}}
  
Note that this does not name the group.
+
|mp= For the global variant of this command see [[setGroupIdGlobal]].
  
To call a [[group]] "grp1", for example, write this in the init field of the [[group]] [[leader]]:
+
|s1= group [[setGroupId]] [nameFormat, nameParam1, ..., nameParamN]
  
grp1 = [[group]] '''this'''
+
|p1= group: [[Object]] or [[Group]]
 +
 
 +
|p2= [nameFormat, nameParam1, ..., nameParamN]: [[Array]]
 +
 
 +
|p3= nameFormat: [[String]] - format template (%keyword1 - %keyword2...etc)
 +
 
 +
|p4= nameParam1: [[String]] - param keyword
 +
 
 +
|r1= [[Nothing]]
 +
 
 +
|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>
 +
 
 +
|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>
 +
 
 +
|x3= '''{{arma1}} / {{arma2}} / {{arma3}}''': <code>_group1 [[setGroupId]] ["Assault Squad"];</code>
 +
 
 +
|x4= '''{{ofp}}''': <code>_group1 [[setGroupId]] ["Delta", "GroupColor4"]</code>
 +
 
 +
|seealso= [[setGroupIdGlobal]], [[groupId]], [[group]]
 +
}}
 +
 
 +
<dl class="command_description">
 +
<!-- Note Section BEGIN -->
 +
 
 +
<dd class="notedate">Posted on April 21, 2015 - 23:21 (UTC)</dd>
 +
<dt class="note">[[User:Killzone Kid|Killzone Kid]]</dt>
 +
<dd class="note">
 +
List of available keywords from config: <code>"[[if]] (([[configName]] _x) select [0, 5] == 'group') [[then]] {
 +
[[diag_log]] ('%' + [[configName]] _x);
 +
[[for]] '_i' [[from]] 0 [[to]] [[count]] [[Magic Variables#x|_x]] - 1 [[do]] {
 +
[[diag_log]] ('* ""' + [[configName]] (_x [[select]] _i) + '"" → ' + [[getText]] (([[Magic Variables#x|_x]] [[select]] _i) >> 'name'));
 +
};
 +
}; [[false]]" [[configClasses]] ([[configFile]] >> "CfgWorlds");</code>
 +
</dd>
 +
 
 +
<!-- Note Section END -->
 +
</dl>
 +
 
 +
 
 +
[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]
 +
[[Category:Scripting Commands OFP 1.46|{{uc:{{PAGENAME}}}}]]
 +
[[Category:Scripting Commands OFP 1.96|{{uc:{{PAGENAME}}}}]]
 +
[[Category:Scripting Commands OFP 1.99|{{uc:{{PAGENAME}}}}]]
 +
{{GameCategory|arma1|Scripting Commands}}
 +
{{GameCategory|arma2|Scripting Commands}}
 +
{{GameCategory|arma3|Scripting Commands}}
 +
{{GameCategory|tkoh|Scripting Commands}}

Revision as of 19:12, 1 March 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 Template:Inline code.
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");