setGroupId: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "\[\[Category:[ _]?Scripting[ _]Commands[ _]Arma[ _]2(\|.*)\]\]" to "{{GameCategory|arma2|Scripting Commands}}")
m (Text replacement - "<sqf>([^↵][^<]*↵[^<]*)<\/sqf>" to "<sqf> $1 </sqf>")
 
(54 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


|gr1= Groups |GROUP1=
|game3= arma1
|version3= 1.00


|arg= global |Multiplayer Arguments=
|game4= arma2
|version4= 1.00


|eff= local |Multiplayer Effects=
|game5= arma2oa
____________________________________________________________________________________________
|version5= 1.50


| 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:
|game6= tkoh
<code>group1 [[setGroupId]] ["Active Group"];
|version6= 1.00
group2 [[setGroupId]] ["Inactive Group"];


group2 [[setGroupId]] ["Active Group"]; {{cc|group1 is "Inactive Group" now}}</code>
|game7= arma3
|version7= 0.50


The identity setup can also consist of format keywords (marked with %) and param keywords taken from '''CfgWorlds''' config.
|gr1= Groups
Basically it is like [[format]] command but with some special group keywords (See Example 2).


{{Feature|arma3 | Possible {{arma3}} values: <spoiler>
|arg= global
'''%GroupSquad''':
* "Squad1" → 1
* "Squad2" → 2
* "Squad3" → 3
* "Squad4" → 4


'''%GroupPlatoon''':
|eff= local
* "Platoon1" → 1
* "Platoon2" → 2
* "Platoon3" → 3
* "Platoon4" → 4


'''%GroupCompany''':
|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>
* "CompanyAlpha" → Alpha
The identity setup can consist of format keywords (marked with '''%''') and param keywords taken from '''CfgWorlds''' config.
* "CompanyBravo" → Bravo
Formatting is almost like using the [[format]] command but with some special group keywords (see {{Link|#Example 2}}).
* "CompanyCharlie" → Charlie
<br>
* "CompanyDelta" → Delta
<spoiler text="Show Arma 3 values table">
* "CompanyEcho" → Echo
{{{!}} class="wikitable"
* "CompanyFoxtrot" → Foxtrot
! %GroupSquad
* "CompanyGolf" → Golf
! %GroupPlatoon
* "CompanyHotel" → Hotel
! %GroupCompany
* "CompanyIndia" → India
! %GroupNames
* "CompanyKilo" → Kilo
! %GroupColors
* "CompanyLima" → Lima
{{!}}- style="vertical-align: top"
* "CompanyMike" → Mike
{{!}}
* "CompanyNovember" → November
* "Squad1" &rarr; 1
* "CompanyOscar" → Oscar
* "Squad2" &rarr; 2
* "CompanyPapa" → Papa
* "Squad3" &rarr; 3
* "CompanyQuebec" → Quebec
* "Squad4" &rarr; 4
* "CompanyRomeo" → Romeo
{{!}}
* "CompanySierra" → Sierra
* "Platoon1" &rarr; 1
* "CompanyTango" → Tango
* "Platoon2" &rarr; 2
* "CompanyUniform" → Uniform
* "Platoon3" &rarr; 3
* "CompanyVictor" → Victor
* "Platoon4" &rarr; 4
* "CompanyWhiskey" → Whiskey
{{!}}
* "CompanyXray" → X-Ray
{{Columns|2|
* "CompanyYankee" → Yankee
* "CompanyAlpha" &rarr; Alpha
* "CompanyZulu" → Zulu
* "CompanyBravo" &rarr; Bravo
 
* "CompanyCharlie" &rarr; etc.
'''%GroupNames''':
* "CompanyDelta"
* "Alpha" → Alpha
* "CompanyEcho"
* "Bravo" → Bravo
* "CompanyFoxtrot"
* "Charlie" → Charlie
* "CompanyGolf"
* "Delta" → Delta
* "CompanyHotel"
* "Echo" → Echo
* "CompanyIndia"
* "Foxtrot" → Foxtrot
* "CompanyKilo"
* "Golf" → Golf
* "CompanyLima"
* "Hotel" → Hotel
* "CompanyMike"
* "November" → November
* "CompanyNovember"
* "Kilo" → Kilo
* "CompanyOscar"
* "Yankee" → Yankee
* "CompanyPapa"
* "Zulu" → Zulu
* "CompanyQuebec"
* "Two" → Two
* "CompanyRomeo"
* "Three" → Three
* "CompanySierra"
* "Buffalo" → Buffalo
* "CompanyTango"
* "Guardian" → Guardian
* "CompanyUniform"
* "Convoy" → Convoy
* "CompanyVictor"
* "Fox" → Fox
* "CompanyWhiskey"
 
* "CompanyXray" &rarr; X-Ray
'''%GroupColors''':
* "CompanyYankee"
* "GroupColor0" → (nothing)
* "CompanyZulu"
* "GroupColor1" → Black
}}
* "GroupColor2" → Red
{{!}}
* "GroupColor3" → Green
{{Columns|2|
* "GroupColor4" → Blue
* "Alpha"
* "GroupColor5" → Yellow
* "Bravo"
* "GroupColor6" → Orange
* "Charlie"
* "GroupColor7" → Pink
* "Delta"
* "Six" → Six
* "Echo"
</spoiler>}}
* "Foxtrot"
{{Informative | From '''{{arma1}}''', you can freely decide the callsign, e.g {{Inline code | [[group]] [[player]] [[setGroupId]] ["First Assault Recon Team"];}}.}}
* "Golf"
{{Informative | In '''{{ofp}}''', group ID cannot be freely decided and format must be of [letter, colour, picture] or [letter, colour]. Possible values: <spoiler>
* "Hotel"
'''Letter:'''
* "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"
* "Alpha"
* "Bravo"
* "Bravo"
Line 114: Line 136:
* "Three"
* "Three"
* "Fox"
* "Fox"
 
}}
'''Colour:'''
{{!}}
* "GroupColor0" → (nothing)
* "GroupColor0" &rarr; (nothing)
* "GroupColor1" → Black
* "GroupColor1" &rarr; Black
* "GroupColor2" → Red
* "GroupColor2" &rarr; Red
* "GroupColor3" → Green
* "GroupColor3" &rarr; Green
* "GroupColor4" → Blue
* "GroupColor4" &rarr; Blue
* "GroupColor5" → Yellow
* "GroupColor5" &rarr; Yellow
* "GroupColor6" → Orange
* "GroupColor6" &rarr; Orange
* "GroupColor7" → Pink
* "GroupColor7" &rarr; Pink
* "Six" → Six
* "Six" &rarr; Six
{{!}}}
</spoiler>
</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>
{{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''_'''ALPHA'''
* STR_CFG_''GRPNAMES''_'''FOX'''
* STR_CFG_''GRPNAMES''_'''FOX'''
Line 135: Line 160:
* STR_CFG_HQ_BASE</spoiler>}}
* STR_CFG_HQ_BASE</spoiler>}}


For the global variant of this command see [[setGroupIdGlobal]]. |DESCRIPTION=
|mp= For the global variant of this command see [[setGroupIdGlobal]].
____________________________________________________________________________________________


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


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


|p2= [nameFormat, nameParam1, ..., nameParamN]: [[Array]] |PARAMETER2=
|p2= nameFormat: [[String]] - format template (%keyword1 - %keyword2...etc)


|p3= nameFormat: [[String]] - format template (%keyword1 - %keyword2...etc) |PARAMETER3=
|p3= nameParamN: [[String]] - param keyword


|p4= nameParam1: [[String]] - param keyword |PARAMETER4=
|r1= [[Nothing]]


| [[Nothing]] |RETURNVALUE=
|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>


|x1= '''{{arma3}}''':<code>[[group]] [[player]] [[setGroupId]] ["Some name for the group"];
|x2= '''{{arma3}}''':
[[hint]] [[groupId]] [[group]] [[player]]; {{cc|"Some name for the group"}}
<sqf>
[[player]] [[sideChat]] "lalala"; {{cc|Some name for the group (KK): "lalala"}}</code> |EXAMPLE1=
group player setGroupId ["%GroupNames :=: %GroupColors", "Alpha", "GroupColor2"];
hint groupId group player; // "Alpha :=: Red"
player sideChat "lalala"; // Alpha :=: Red (KK): "lalala"
</sqf>


|x2= '''{{arma3}}''':<code>[[group]] [[player]] [[setGroupId]] ["%GroupNames :{{=}}: %GroupColors", "Alpha", "GroupColor2"];
|x3= '''{{arma1}} / {{arma2}} / {{arma3}}''':
[[hint]] [[groupId]] [[group]] [[player]]; {{cc|"Alpha :{{=}}: Red"}}
<sqf>group player setGroupId ["First Assault Recon Team"];</sqf>
[[player]] [[sideChat]] "lalala"; {{cc|Alpha :{{=}}: Red (KK): "lalala"}}</code> |EXAMPLE2=
'''{{ofp}}''':
<sqf>_group1 setGroupId ["Delta", "GroupColor4"]</sqf>


|x3= '''ArmA / {{arma2}} / {{arma3}}''': <code>_group1 [[setGroupId]] ["Assault Squad"];</code> |EXAMPLE3=
|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>


|x4= '''OFP''': <code>_group1 [[setGroupId]] ["Delta", "GroupColor4"]</code> |EXAMPLE4=
|seealso= [[setGroupIdGlobal]] [[groupId]] [[group]]
____________________________________________________________________________________________
}}


| [[setGroupIdGlobal]], [[groupId]], [[group]] |SEEALSO=
{{Note
|user= Killzone_Kid
|timestamp= 20150421232100
|text= {{Wiki|extractionScript|CfgWorlds/Group*}}
}}
}}
<h3 style="display:none">Notes</h3>
<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]] [[_x]] - 1 [[do]] {
[[diag_log]] ('* ""' + [[configName]] (_x [[select]] _i) + '"" → ' + [[getText]] (([[_x]] [[select]] _i) >> 'name'));
};
}; [[false]]" [[configClasses]] ([[configFile]] >> "CfgWorlds");</code>
</dd>
<!-- Note Section END -->
</dl>
<h3 style="display:none">Bottom Section</h3>
[[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}}
[[Category:Scripting Commands Take On Helicopters|{{uc:{{PAGENAME}}}}]]
[[Category:Command_Group:_Object_Manipulation|{{uc:{{PAGENAME}}}}]]

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"