setGroupId: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (template:command argument fix)
m (Text replacement - "<sqf>([^↵][^<]*↵[^<]*)<\/sqf>" to "<sqf> $1 </sqf>")
 
(71 intermediate revisions by 4 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


|arg= global |= Arguments in MP
|game3= arma1
|version3= 1.00


|eff= local |= Effects in MP
|game4= arma2
____________________________________________________________________________________________
|version4= 1.00


| Sets a group's identity, how it will be displayed in chat, for example. While groups on the different [[Side|sides]] can have identical ids, the groups on the same [[side]] cannot. When given id exists already, the group which currently has it will simply swap it with the current id of the group for which this id is intended. For example:
|game5= arma2oa
<code>group1 <nowiki>=</nowiki> [[createGroup]] [[west]];
|version5= 1.50
group2 <nowiki>=</nowiki> [[createGroup]] [[west]];


group1 [[setGroupId]] ["Active Group"];
|game6= tkoh
group2 [[setGroupId]] ["Inactive Group"];
|version6= 1.00


[[systemChat]] [[groupId]] group1; //"Active Group";
|game7= arma3
[[systemChat]] [[groupId]] group2; //"Inactive Group";
|version7= 0.50


group2 [[setGroupId]] ["Active Group"];
|gr1= Groups


[[systemChat]] [[groupId]] group1; //"Inactive Group";
|arg= global
[[systemChat]] [[groupId]] group2; //"Active Group";</code>


The identity setup could 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. For Arma 3 possible values are:
|eff= local
<br><br>
%GroupSquad
* "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
%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
%GroupColors
* "GroupColor1" -> Black
* "GroupColor2" -> Red
* "GroupColor3" -> Green
* "GroupColor4" -> Blue
* "GroupColor5" -> Yellow
* "GroupColor6" -> Orange
* "GroupColor7" -> Pink
* "GroupColor0" ->
* "Six" -> Six
 
For global variant of this command use [[setGroupIdGlobal]].
|DESCRIPTION=
____________________________________________________________________________________________
 
| group '''setGroupId''' [nameFormat, nameParam1, ..., nameParamN] |SYNTAX=
 
|p1= group: [[Object]] or [[Group]] |PARAMETER1=
 
|p2= [nameFormat, nameParam1, ..., nameParamN]: [[Array]] |PARAMETER2=
|p3= nameFormat: [[String]] - format template (%keyword1 - %keyword2...etc) |PARAMETER2=
|p4= nameParam1: [[String]] - param keyword |PARAMETER2=
 
| [[Nothing]] |RETURNVALUE=
____________________________________________________________________________________________
|x1= '''Arma 3''':<code>[[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"</code>|EXAMPLE1=  
|x2= '''Arma 3''':<code>[[group]] [[player]] [[setGroupId]] ["%GroupNames :=: %GroupColors","Alpha","GroupColor2"];
[[hint]] [[groupId]] [[group]] [[player]]; //"Alpha :=: Red"
[[player]] [[sideChat]] "lalala"; //Alpha :=: Red (KK): "lalala"</code>|EXAMPLE2=
|x3= '''OFP''':<code>_group1 [[setGroupId]] ["Delta","GroupColor4"]</code> |EXAMPLE3=
|x4= '''ArmA / ArmA 2''':<code>_group1 [[setGroupId]] ["Assault Squad"]</code> |EXAMPLE4=
____________________________________________________________________________________________
 
| [[setGroupIdGlobal]], [[groupId]], [[group]] |SEEALSO=


|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>
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 {{Link|#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 {{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>}}


<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">
<dd class="note">In '''OFP''', group ID format must be [letter, color, picture] or [letter, color].


Letter is one of:
|s1= group [[setGroupId]] [nameFormat, nameParam1, nameParam2, ...]
* '''"Alpha"'''
* '''"Bravo"'''
* '''"Charlie"'''
* '''"Delta"'''
* '''"Echo"'''
* '''"Foxtrot"'''
* '''"Golf"'''
* '''"Hotel"'''
* '''"Kilo"'''
* '''"Yankee"'''


* '''"Zulu"'''
|p1= group: [[Object]] or [[Group]]
* '''"Buffalo"'''
* '''"Convoy"'''
* '''"Guardian"'''
* '''"November"'''
* '''"Two"'''
* '''"Three"'''
* '''"Fox"'''


Colour may be one of the following:
|p2= nameFormat: [[String]] - format template (%keyword1 - %keyword2...etc)
* '''"GroupColor0"''' - (Nothing)
* '''"GroupColor1"''' - Black
* '''"GroupColor2"''' - Red
* '''"GroupColor3"''' - Green
* '''"GroupColor4"''' - Blue
* '''"GroupColor5"''' - Yellow
* '''"GroupColor6"''' - Orange
* '''"GroupColor7"''' - Pink
* '''"Six"''' - Six
<dd class="notedate">Posted on August 4, 2006 - 11:01
<dt class="note">'''[[User:Hardrock|hardrock]]'''<dd class="note">''Notes from before the conversion:''


Note that this command does not name the group. To call a [[group]] "grp1", for example, write this in the init field of the [[group]] [[leader]]:
|p3= nameParamN: [[String]] - param keyword


grp1 <nowiki>=</nowiki> [[group]] this
|r1= [[Nothing]]


|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>


<dd class="notedate">Posted on December 9, 2006 - 12:20
|x2= '''{{arma3}}''':
<dt class="note">'''[[User:Mondkalb|Mondkalb]]'''<dd class="note">''Selfdefined Callsigns:''
<sqf>
group player setGroupId ["%GroupNames :=: %GroupColors", "Alpha", "GroupColor2"];
hint groupId group player; // "Alpha :=: Red"
player sideChat "lalala"; // Alpha :=: Red (KK): "lalala"
</sqf>


In [[Armed Assault]] you're able to define the callsignletter by yourself. This can be for example "Fireteam", or "Specialforces".
|x3= '''{{arma1}} / {{arma2}} / {{arma3}}''':
<sqf>group player setGroupId ["First Assault Recon Team"];</sqf>
'''{{ofp}}''':
<sqf>_group1 setGroupId ["Delta", "GroupColor4"]</sqf>


this setgroupId ["Attackteam"]
|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>


<dd class="notedate">
|seealso= [[setGroupIdGlobal]] [[groupId]] [[group]]
<dt class="note">'''[[User:Ceeeb|Ceeeb]]'''
}}
<dd class="note">
In '''OFP v1.96''', the radio callsign strings for a mission can be redefined  by creating a [[Stringtable.csv]] in the mission folder. All string names except FOX can be found within the main stringtable.csv. Note "SIX" has a string suggesting it is a groupname, although the engine uses it as a colour. Some examples of the string names : STR_CFG_GRPNAMES_ALPHA, STR_CFG_GRPNAMES_FOX, STR_CFG_GRPCOL_BLACK, STR_CFG_GRPNAMES_SIX, STR_CFG_FIREFLYBASE, STR_CFG_PAPABEAR, STR_CFG_HQ_BASE, STR_CFG_HQ_BASE.


 
{{Note
<!-- Note Section END -->
|user= Killzone_Kid
</dl>
|timestamp= 20150421232100
 
|text= {{Wiki|extractionScript|CfgWorlds/Group*}}
<h3 style="display:none">Bottom Section</h3>
}}
 
 
[[Category:Scripting Commands|SETGROUPID]]
[[Category:Scripting Commands OFP 1.99|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands OFP 1.96|SETGROUPID]]
[[Category:Scripting Commands OFP 1.46|SETGROUPID]]
[[Category:Scripting Commands ArmA|SETGROUPID]]
[[Category:Scripting Commands ArmA2|{{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}}}}]]
 
<!-- CONTINUE Notes -->
<dl class="command_description">
<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] <nowiki>==</nowiki> '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>
</dl>
<!-- DISCONTINUE Notes -->

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"