Difference between revisions of "setGroupId"

From Bohemia Interactive Community
Jump to navigation Jump to search
m
m (Fix note)
 
(76 intermediate revisions by 16 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
  
| Set group identity. Id format is [letter, color, picture] or [letter, color].
+
|game3= arma1
Letter is one of:
+
|version3= 1.00
* '''"Alpha"'''
 
* '''"Bravo"'''
 
* '''"Charlie"'''
 
* '''"Delta"'''
 
* '''"Echo"'''
 
* '''"Foxtrot"'''
 
* '''"Golf"'''
 
* '''"Hotel"'''
 
* '''"Kilo"'''
 
* '''"Yankee"'''
 
  
* '''"Zulu"'''
+
|game4= arma2
* '''"Buffalo"'''
+
|version4= 1.00
* '''"Convoy"'''
 
* '''"Guardian"'''
 
* '''"November"'''
 
* '''"Two"'''
 
* '''"Three"'''
 
  
Colour can be one of "GroupColor0" to "GroupColor7":
+
|game5= arma2oa
* '''0''' - No colour
+
|version5= 1.50
* '''1''' - Black
 
* '''2''' - Red
 
* '''3''' - Green
 
* '''4''' - Blue
 
* '''5''' - Yellow
 
* '''6''' - Orange
 
* '''7''' - Pink
 
|= Description
 
____________________________________________________________________________________________
 
  
| group '''setGroupId''' [nameFomat, nameParam1, ...] |= Syntax
+
|game6= tkoh
 +
|version6= 1.00
  
|p1= group: [[Object or Group]] |= Parameter 1
+
|game7= arma3
 +
|version7= 0.50
  
|p2= [nameFomat, nameParam1, ...]: [[Array]] |= Parameter 2
+
|gr1= Groups
  
| [[Nothing]] |= Return value
+
|arg= global
____________________________________________________________________________________________
 
 
 
|x1= <pre>group1 setGroupId ["Delta","GroupColor4"]</pre> |= Example 1
 
____________________________________________________________________________________________
 
  
| |= See also
+
|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>
 +
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}}).
 +
<br>
 +
<spoiler text="Show Arma 3 values table">
 +
{{{!}} class="wikitable"
 +
! %GroupSquad
 +
! %GroupPlatoon
 +
! %GroupCompany
 +
! %GroupNames
 +
! %GroupColors
 +
{{!}}- style="vertical-align: top"
 +
{{!}}
 +
* "Squad1" &rarr; 1
 +
* "Squad2" &rarr; 2
 +
* "Squad3" &rarr; 3
 +
* "Squad4" &rarr; 4
 +
{{!}}
 +
* "Platoon1" &rarr; 1
 +
* "Platoon2" &rarr; 2
 +
* "Platoon3" &rarr; 3
 +
* "Platoon4" &rarr; 4
 +
{{!}}
 +
{{Columns|2|
 +
* "CompanyAlpha" &rarr; Alpha
 +
* "CompanyBravo" &rarr; Bravo
 +
* "CompanyCharlie" &rarr; etc.
 +
* "CompanyDelta"
 +
* "CompanyEcho"
 +
* "CompanyFoxtrot"
 +
* "CompanyGolf"
 +
* "CompanyHotel"
 +
* "CompanyIndia"
 +
* "CompanyKilo"
 +
* "CompanyLima"
 +
* "CompanyMike"
 +
* "CompanyNovember"
 +
* "CompanyOscar"
 +
* "CompanyPapa"
 +
* "CompanyQuebec"
 +
* "CompanyRomeo"
 +
* "CompanySierra"
 +
* "CompanyTango"
 +
* "CompanyUniform"
 +
* "CompanyVictor"
 +
* "CompanyWhiskey"
 +
* "CompanyXray" &rarr; X-Ray
 +
* "CompanyYankee"
 +
* "CompanyZulu"
 
}}
 
}}
 +
{{!}}
 +
{{Columns|2|
 +
* "Alpha"
 +
* "Bravo"
 +
* "Charlie"
 +
* "Delta"
 +
* "Echo"
 +
* "Foxtrot"
 +
* "Golf"
 +
* "Hotel"
 +
* "November"
 +
* "Kilo"
 +
* "Yankee"
 +
* "Zulu"
 +
* "Convoy"
 +
* "Buffalo"
 +
* "Guardian"
 +
* "Two"
 +
* "Three"
 +
* "Fox"
 +
}}
 +
{{!}}
 +
* "GroupColor0" &rarr; (nothing)
 +
* "GroupColor1" &rarr; Black
 +
* "GroupColor2" &rarr; Red
 +
* "GroupColor3" &rarr; Green
 +
* "GroupColor4" &rarr; Blue
 +
* "GroupColor5" &rarr; Yellow
 +
* "GroupColor6" &rarr; Orange
 +
* "GroupColor7" &rarr; Pink
 +
* "Six" &rarr; Six
 +
{{!}}}
 +
</spoiler>
 +
<spoiler text="Show OFP values table">
 +
{{{!}} class="wikitable"
 +
! Letter
 +
! Colour
 +
{{!}}- style="vertical-align: top"
 +
{{!}}
 +
{{Columns|2|
 +
* "Alpha"
 +
* "Bravo"
 +
* "Charlie"
 +
* "Delta"
 +
* "Echo"
 +
* "Foxtrot"
 +
* "Golf"
 +
* "Hotel"
 +
* "Kilo"
 +
* "Yankee"
 +
* "Zulu"
 +
* "Buffalo"
 +
* "Convoy"
 +
* "Guardian"
 +
* "November"
 +
* "Two"
 +
* "Three"
 +
* "Fox"
 +
}}
 +
{{!}}
 +
* "GroupColor0" &rarr; (nothing)
 +
* "GroupColor1" &rarr; Black
 +
* "GroupColor2" &rarr; Red
 +
* "GroupColor3" &rarr; Green
 +
* "GroupColor4" &rarr; Blue
 +
* "GroupColor5" &rarr; Yellow
 +
* "GroupColor6" &rarr; Orange
 +
* "GroupColor7" &rarr; Pink
 +
* "Six" &rarr; Six
 +
{{!}}}
 +
</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}}.
 +
* 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>}}
  
<h3 style="display:none">Notes</h3>
+
|mp= For the global variant of this command see [[setGroupIdGlobal]].
<dl class="command_description">
 
<!-- Note Section BEGIN -->
 
  
<dd class="notedate">Posted on August 4, 2006 - 11:01</dd>
+
|s1= group [[setGroupId]] [nameFormat, nameParam1, ..., nameParamN]
<dt class="note">'''[[User:Hardrock|hardrock]]'''</dt><dd class="note">''Notes from before the conversion:''
 
  
Color can also be set to "Six".
+
|p1= group: [[Object]] or [[Group]]
  
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]]:
+
|p2= nameFormat: [[String]] - format template (%keyword1 - %keyword2...etc)
  
grp1 <nowiki>=</nowiki> [[group]] this
+
|p3= nameParam1: [[String]] - param keyword
</dd>
 
  
<dd class="notedate">Posted on December 9, 2006 - 12:20</dd>
+
|r1= [[Nothing]]
<dt class="note">'''[[User:Mondkalb|Mondkalb]]'''</dt><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","groupcolor2"]
+
|x2= '''{{arma3}}''':<code>[[group]] [[player]] [[setGroupId]] ["%GroupNames :{{=}}: %GroupColors", "Alpha", "GroupColor2"];
</dd>
+
[[hint]] [[groupId]] [[group]] [[player]]; {{cc|"Alpha :{{=}}: Red"}}
<!-- Note Section END -->
+
[[player]] [[sideChat]] "lalala"; {{cc|Alpha :{{=}}: Red (KK): "lalala"}}</code>
</dl>
 
  
<h3 style="display:none">Bottom Section</h3>
+
|x3= '''{{arma1}} / {{arma2}} / {{arma3}}''': <code>[[group]] [[player]] [[setGroupId]] ["First Assault Recon Team"];</code>
 +
'''{{ofp}}''': <code>_group1 [[setGroupId]] ["Delta", "GroupColor4"]</code>
  
 +
|x5= 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>
  
 +
|seealso= [[setGroupIdGlobal]], [[groupId]], [[group]]
 +
}}
  
[[Category:Scripting Commands|SETGROUPID]]
+
{{Note
[[Category:Scripting Commands OFP 1.96|SETGROUPID]]
+
|user= Killzone Kid
[[Category:Scripting Commands OFP 1.46|SETGROUPID]]
+
|timestamp= 20150421232100
[[Category:Scripting Commands ArmA|SETGROUPID]]
+
|text= {{Wiki|extractionScript|CfgWorlds/Group*}}
 +
}}

Latest revision as of 20:03, 2 September 2021

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).
Show Arma 3 values table

Show OFP values table

Operation Flashpoint
  • 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: Show text
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:
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
Posted on Apr 21, 2015 - 23:21 (CEST)
Killzone Kid
Extraction script can be found on the Biki Export Scripts page.