setGroupId: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Fixed link)
m (Text replacement - "|Game version=" to "|Game version= |gr1= Groups |GROUP1=")
(40 intermediate revisions by 17 users not shown)
Line 1: Line 1:
{{Command|= Comments
{{Command|Comments=
____________________________________________________________________________________________
____________________________________________________________________________________________


| ofp |= Game name
| ofp |Game name=


|1.00|= Game version
|gr1= Groups |GROUP1=
 
 
 
|1.00|Game version=
|gr1= Groups |GROUP1=
 
|arg= global |Multiplayer Arguments=
 
|eff= local |Multiplayer Effects=
____________________________________________________________________________________________
____________________________________________________________________________________________


| Set group identity. Id format is [letter, color, picture] or [letter, color].
| 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:
Letter is one of:
<code>group1 [[setGroupId]] ["Active Group"];
* '''"Alpha"'''
group2 [[setGroupId]] ["Inactive Group"];
* '''"Bravo"'''
 
* '''"Charlie"'''
group2 [[setGroupId]] ["Active Group"]; {{cc|group1 is "Inactive Group" now}}</code>
* '''"Delta"'''
 
* '''"Echo"'''
The identity setup can also consist of format keywords (marked with %) and param keywords taken from '''CfgWorlds''' config.
* '''"Foxtrot"'''
Basically it is like [[format]] command but with some special group keywords (See Example 2).
* '''"Golf"'''
 
* '''"Hotel"'''
{{Feature arma3 | Possible {{arma3}} values: <spoiler>
* '''"Kilo"'''
'''%GroupSquad''':
* '''"Yankee"'''
* "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


* '''"Zulu"'''
'''%GroupNames''':
* '''"Buffalo"'''
* "Alpha" → Alpha
* '''"Convoy"'''
* "Bravo" → Bravo
* '''"Guardian"'''
* "Charlie" → Charlie
* '''"November"'''
* "Delta" → Delta
* '''"Two"'''
* "Echo" → Echo
* '''"Three"'''
* "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


Colour can be one of "GroupColor0" to "GroupColor7":
'''%GroupColors''':
* '''0''' - No colour
* "GroupColor0" → (nothing)
* '''1''' - Black
* "GroupColor1" → Black
* '''2''' - Red
* "GroupColor2" → Red
* '''3''' - Green
* "GroupColor3" → Green
* '''4''' - Blue
* "GroupColor4" → Blue
* '''5''' - Yellow
* "GroupColor5" → Yellow
* '''6''' - Orange
* "GroupColor6" → Orange
* '''7''' - Pink
* "GroupColor7" → Pink
|= Description
* "Six" → Six
</spoiler>}}
{{Informative | From '''{{arma}}''', you can freely decide the callsign, e.g {{Inline code | [[group]] [[player]] [[setGroupId]] ["First Assault Recon Team"];}}.}}
{{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"
 
'''Colour:'''
* "GroupColor0" → (nothing)
* "GroupColor1" → Black
* "GroupColor2" → Red
* "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>}}
 
For the global variant of this command see [[setGroupIdGlobal]]. |DESCRIPTION=
____________________________________________________________________________________________
____________________________________________________________________________________________


| group '''setGroupId''' id |= Syntax
| group [[setGroupId]] [nameFormat, nameParam1, ..., nameParamN] |SYNTAX=


|p1= group: [[Object or Group]] |= Parameter 1
|p1= group: [[Object]] or [[Group]] |PARAMETER1=


|p2= id: [[Array]] |= Parameter 2
|p2= [nameFormat, nameParam1, ..., nameParamN]: [[Array]] |PARAMETER2=


| [[Nothing]] |= Return value
|p3= nameFormat: [[String]] - format template (%keyword1 - %keyword2...etc) |PARAMETER3=
 
|p4= nameParam1: [[String]] - param keyword |PARAMETER4=
 
| [[Nothing]] |RETURNVALUE=
____________________________________________________________________________________________
____________________________________________________________________________________________
 
 
|x1= <pre>group1 setGroupId ["Delta","GroupColor4"]</pre> |= Example 1
|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> |EXAMPLE1=
 
|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> |EXAMPLE2=
 
|x3= '''ArmA / {{arma2}} / {{arma3}}''': <code>_group1 [[setGroupId]] ["Assault Squad"];</code> |EXAMPLE3=
 
|x4= '''OFP''': <code>_group1 [[setGroupId]] ["Delta", "GroupColor4"]</code> |EXAMPLE4=
____________________________________________________________________________________________
____________________________________________________________________________________________


| |= See also
| [[setGroupIdGlobal]], [[groupId]], [[group]] |SEEALSO=
 
}}
}}


Line 60: Line 174:
<!-- Note Section BEGIN -->
<!-- Note Section BEGIN -->


<dd class="notedate">Posted on August 4, 2006 - 11:01</dd>
<dd class="notedate">Posted on April 21, 2015 - 23:21 (UTC)</dd>
<dt class="note">'''[[User:Hardrock|hardrock]]'''</dt><dd class="note">''Notes from before the conversion:''
<dt class="note">[[User:Killzone Kid|Killzone Kid]]</dt>
 
<dd class="note">
Color can also be set to "Six".
List of available keywords from config: <code>"[[if]] (([[configName]] _x) select [0, 5] == 'group') [[then]] {
 
[[diag_log]] ('%' + [[configName]] _x);
Note that this does not name the group. To call a [[group]] "grp1", for example, write this in the init field of the [[group]] [[leader]]:
[[for]] '_i' [[from]] 0 [[to]] [[count]] [[_x]] - 1 [[do]] {
 
[[diag_log]] ('* ""' + [[configName]] (_x [[select]] _i) + '"" → ' + [[getText]] (([[_x]] [[select]] _i) >> 'name'));
grp1 <nowiki>=</nowiki> [[group]] this
};
}; [[false]]" [[configClasses]] ([[configFile]] >> "CfgWorlds");</code>
</dd>
</dd>


Line 76: Line 191:




 
[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands|SETGROUPID]]
[[Category:Scripting Commands OFP 1.46|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands OFP 1.96|SETGROUPID]]
[[Category:Scripting Commands OFP 1.96|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands OFP 1.46|SETGROUPID]]
[[Category:Scripting Commands OFP 1.99|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands ArmA|SETGROUPID]]
[[Category:Scripting Commands Armed Assault|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands Arma 2|{{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}}}}]]

Revision as of 17:14, 18 September 2020

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). Template:Feature arma3
From Arma, 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