setGroupId: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
No edit summary
m (Text replacement - "<sqf>([^↵][^<]*↵[^<]*)<\/sqf>" to "<sqf> $1 </sqf>")
 
(114 intermediate revisions by 19 users not shown)
Line 1: Line 1:
back to [[Scripting_Reference#S|COMREF]]
{{RV|type=command


<h2 style="color:#000066">'''''group'' setGroupId ''id'''''</h2>
|game1= ofp
|version1= 1.00


|game2= ofpe
|version2= 1.00


'''Operand types:'''
|game3= arma1
|version3= 1.00


'''group:''' [[Object or Group]]
|game4= arma2
|version4= 1.00


'''id:''' [[Array]]
|game5= arma2oa
|version5= 1.50


'''Type of returned value:'''
|game6= tkoh
|version6= 1.00


[[Nothing]]
|game7= arma3
|version7= 0.50


'''Description:'''
|gr1= Groups


Set '''group identity'''.
|arg= global


'''Id''' format is '''''[letter, color, picture]''''' or '''''[letter, color]'''''.<br>
|eff= local
'''Letter''' is one of:


* '''"Alpha"'''
|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 {{Link|#Example 4}}.<br>
* '''"Bravo"'''
The identity setup can consist of format keywords (marked with '''%''') and param keywords taken from '''CfgWorlds''' config.
* '''"Charlie"'''
Formatting is almost like using the [[format]] command but with some special group keywords (see {{Link|#Example 2}}).
* '''"Delta"'''
<br>
* '''"Echo"'''
<spoiler text="Show Arma 3 values table">
* '''"Foxtrot"'''
{{{!}} class="wikitable"
* '''"Golf"'''
! %GroupSquad
* '''"Hotel"'''
! %GroupPlatoon
* '''"Kilo"'''
! %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 {{Link|#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>}}


'''Colour''' can be one of "GroupColor0" to "GroupColor7".
|mp= For the global variant of this command see [[setGroupIdGlobal]].


|s1= group [[setGroupId]] [nameFormat, nameParam1, nameParam2, ...]


'''Example:'''
|p1= group: [[Object]] or [[Group]]


group1 '''setGroupId''' ["Delta","GroupColor4"]
|p2= nameFormat: [[String]] - format template (%keyword1 - %keyword2...etc)


|p3= nameParamN: [[String]] - param keyword


'''Comments:'''
|r1= [[Nothing]]


Additional values for '''letter''' are:
|x1= '''{{arma3}}''':
<sqf>
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"
</sqf>


* '''"Yankee"'''
|x2= '''{{arma3}}''':
* '''"Zulu"'''
<sqf>
* '''"Buffalo"'''
group player setGroupId ["%GroupNames :=: %GroupColors", "Alpha", "GroupColor2"];
* '''"Convoy"'''
hint groupId group player; // "Alpha :=: Red"
* '''"Guardian"'''
player sideChat "lalala"; // Alpha :=: Red (KK): "lalala"
* '''"November"'''
</sqf>
* '''"Two"'''
* '''"Three"'''


'''Color''' can also be set to '''"Six"'''.
|x3= '''{{arma1}} / {{arma2}} / {{arma3}}''':
<sqf>group player setGroupId ["First Assault Recon Team"];</sqf>
'''{{ofp}}''':
<sqf>_group1 setGroupId ["Delta", "GroupColor4"]</sqf>


Following is a list of GroupColors:
|x5= When trying to apply the same callsign to two groups of the same side, the callsigns will simply be swapped, e.g:
<sqf>
group1 setGroupId ["Active Group"];
group2 setGroupId ["Inactive Group"];
group2 setGroupId ["Active Group"]; // group1 is "Inactive Group" now
</sqf>


* '''0''' - No colour
|seealso= [[setGroupIdGlobal]] [[groupId]] [[group]]
* '''1''' - Black
}}
* '''2''' - Red
* '''3''' - Green
* '''4''' - Blue
* '''5''' - Yellow
* '''6''' - Orange
* '''7''' - Pink


Note that this does not name the group.
{{Note
 
|user= Killzone_Kid
To call a [[group]] "grp1", for example, write this in the init field of the [[group]] [[leader]]:
|timestamp= 20150421232100
 
|text= {{Wiki|extractionScript|CfgWorlds/Group*}}
grp1 = [[group]] '''this'''
}}

Latest revision as of 19:42, 3 September 2024

Logo A0.png1.00ofpe logo.png1.00Logo A1 black.png1.00Logo A2.png1.00A2 OA Logo.png1.50tkoh logo small.png1.00Arma 3 logo black.png0.50
GAGlobalLELocal
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).
%GroupSquad %GroupPlatoon %GroupCompany %GroupNames %GroupColors
  • "Squad1" → 1
  • "Squad2" → 2
  • "Squad3" → 3
  • "Squad4" → 4
  • "Platoon1" → 1
  • "Platoon2" → 2
  • "Platoon3" → 3
  • "Platoon4" → 4
  • "CompanyAlpha" → Alpha
  • "CompanyBravo" → Bravo
  • "CompanyCharlie" → etc.
  • "CompanyDelta"
  • "CompanyEcho"
  • "CompanyFoxtrot"
  • "CompanyGolf"
  • "CompanyHotel"
  • "CompanyIndia"
  • "CompanyKilo"
  • "CompanyLima"
  • "CompanyMike"
  • "CompanyNovember"
  • "CompanyOscar"
  • "CompanyPapa"
  • "CompanyQuebec"
  • "CompanyRomeo"
  • "CompanySierra"
  • "CompanyTango"
  • "CompanyUniform"
  • "CompanyVictor"
  • "CompanyWhiskey"
  • "CompanyXray" → X-Ray
  • "CompanyYankee"
  • "CompanyZulu"
  • "Alpha"
  • "Bravo"
  • "Charlie"
  • "Delta"
  • "Echo"
  • "Foxtrot"
  • "Golf"
  • "Hotel"
  • "November"
  • "Kilo"
  • "Yankee"
  • "Zulu"
  • "Convoy"
  • "Buffalo"
  • "Guardian"
  • "Two"
  • "Three"
  • "Fox"
  • "GroupColor0" → (nothing)
  • "GroupColor1" → Black
  • "GroupColor2" → Red
  • "GroupColor3" → Green
  • "GroupColor4" → Blue
  • "GroupColor5" → Yellow
  • "GroupColor6" → Orange
  • "GroupColor7" → Pink
  • "Six" → Six
↑ Back to spoiler's top
Letter Colour
  • "Alpha"
  • "Bravo"
  • "Charlie"
  • "Delta"
  • "Echo"
  • "Foxtrot"
  • "Golf"
  • "Hotel"
  • "Kilo"
  • "Yankee"
  • "Zulu"
  • "Buffalo"
  • "Convoy"
  • "Guardian"
  • "November"
  • "Two"
  • "Three"
  • "Fox"
  • "GroupColor0" → (nothing)
  • "GroupColor1" → Black
  • "GroupColor2" → Red
  • "GroupColor3" → Green
  • "GroupColor4" → Blue
  • "GroupColor5" → Yellow
  • "GroupColor6" → Orange
  • "GroupColor7" → Pink
  • "Six" → Six
↑ Back to spoiler's top
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:
    • 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
Multiplayer:
For the global variant of this command see setGroupIdGlobal.
Groups:
Groups

Syntax

Syntax:
group setGroupId [nameFormat, nameParam1, nameParam2, ...]
Parameters:
group: Object or Group
nameFormat: String - format template (%keyword1 - %keyword2...etc)
nameParamN: 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:
setGroupIdGlobal groupId group

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
Killzone_Kid - c
Posted on Apr 21, 2015 - 23:21 (UTC)
ⓘ
Extraction script can be found on the Biki Export Scripts page.
Retrieved from "https://community.bistudio.com/wiki?title=setGroupId&oldid=369324"