Difference between revisions of "setGroupId"

From Bohemia Interactive Community
Jump to navigation Jump to search
m (VBS2 scripting category removal)
m (Text replacement - " \{\{GameCategory\|[a-z]+[0-9]?\|Scripting Commands\}\}" to "")
 
(63 intermediate revisions by 10 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 a group's identity.
+
|game3= arma1
|= Description
+
|version3= 1.00
____________________________________________________________________________________________
 
  
| group '''setGroupId''' [nameFomat, nameParam1, ...] |= Syntax
+
|game4= arma2
 +
|version4= 1.00
  
|p1= group: [[Object]] or [[Group]] |= Parameter 1
+
|game5= arma2oa
 +
|version5= 1.50
  
|p2= [nameFomat, nameParam1 ...]: [[Array]] of strings. |= Parameter 2
+
|game6= tkoh
 +
|version6= 1.00
  
| [[Nothing]] |= Return value
+
|game7= arma3
____________________________________________________________________________________________
+
|version7= 0.50
 
 
|x1= '''OFP''':<pre>_group1 setGroupId ["Delta","GroupColor4"]</pre> |= Example 1
 
|x2= '''ArmA''':<pre>_group1 setGroupId ["Assault Squad"]</pre> |= Example 2
 
____________________________________________________________________________________________
 
  
| |= See also
+
|gr1= Groups
  
}}
+
|arg= global
 +
 
 +
|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 (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:
 +
<code>group1 [[setGroupId]] ["Active Group"];
 +
group2 [[setGroupId]] ["Inactive Group"];
 +
group2 [[setGroupId]] ["Active Group"]; {{cc|group1 is "Inactive Group" now}}</code>
 +
 
 +
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).
 +
 
 +
{{Feature | arma3 | Possible {{arma3}} values: <spoiler>
 +
'''%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''':
 +
* "GroupColor0" → (nothing)
 +
* "GroupColor1" → Black
 +
* "GroupColor2" → Red
 +
* "GroupColor3" → Green
 +
* "GroupColor4" → Blue
 +
* "GroupColor5" → Yellow
 +
* "GroupColor6" → Orange
 +
* "GroupColor7" → Pink
 +
* "Six" → Six
 +
</spoiler>}}
 +
{{Feature | Informative | Since '''{{arma1}}''', you can freely decide the callsign, e.g {{ic| [[group]] [[player]] [[setGroupId]] ["First Assault Recon Team"];}}.}}
 +
{{Feature | 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>}}
 +
 
 +
|mp= For the global variant of this command see [[setGroupIdGlobal]].
 +
 
 +
|s1= group [[setGroupId]] [nameFormat, nameParam1, ..., nameParamN]
  
<h3 style="display:none">Notes</h3>
+
|p1= group: [[Object]] or [[Group]]
<dl class="command_description">
 
<!-- Note Section BEGIN -->
 
<dd class="notedate"></dd>
 
<dd class="note">In '''OFP''', group ID format must be [letter, color, picture] or [letter, color].
 
  
Letter is one of:  
+
|p2= [nameFormat, nameParam1, ..., nameParamN]: [[Array]]
* '''"Alpha"'''
 
* '''"Bravo"'''
 
* '''"Charlie"'''
 
* '''"Delta"'''
 
* '''"Echo"'''
 
* '''"Foxtrot"'''
 
* '''"Golf"'''
 
* '''"Hotel"'''
 
* '''"Kilo"'''
 
* '''"Yankee"'''
 
  
* '''"Zulu"'''
+
|p3= nameFormat: [[String]] - format template (%keyword1 - %keyword2...etc)
* '''"Buffalo"'''
 
* '''"Convoy"'''
 
* '''"Guardian"'''
 
* '''"November"'''
 
* '''"Two"'''
 
* '''"Three"'''
 
* '''"Fox"'''
 
  
Colour may be one of the following:
+
|p4= nameParam1: [[String]] - param keyword
* '''"GroupColor0"''' - (Nothing)
 
* '''"GroupColor1"''' - Black
 
* '''"GroupColor2"''' - Red
 
* '''"GroupColor3"''' - Green
 
* '''"GroupColor4"''' - Blue
 
* '''"GroupColor5"''' - Yellow
 
* '''"GroupColor6"''' - Orange
 
* '''"GroupColor7"''' - Pink
 
* '''"Six"''' - Six</dd>
 
<dd class="notedate">Posted on August 4, 2006 - 11:01</dd>
 
<dt class="note">'''[[User:Hardrock|hardrock]]'''</dt><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]]:
+
|r1= [[Nothing]]
  
grp1 <nowiki>=</nowiki> [[group]] this
+
|x1= '''{{arma3}}''':<code>[[group]] [[player]] [[setGroupId]] ["Some name for the group"];
</dd>
+
[[hint]] [[groupId]] [[group]] [[player]]; {{cc|"Some name for the group"}}
 +
[[player]] [[sideChat]] "lalala"; {{cc|Some name for the group (KK): "lalala"}}</code>
  
<dd class="notedate">Posted on December 9, 2006 - 12:20</dd>
+
|x2= '''{{arma3}}''':<code>[[group]] [[player]] [[setGroupId]] ["%GroupNames :{{=}}: %GroupColors", "Alpha", "GroupColor2"];
<dt class="note">'''[[User:Mondkalb|Mondkalb]]'''</dt><dd class="note">''Selfdefined Callsigns:''
+
[[hint]] [[groupId]] [[group]] [[player]]; {{cc|"Alpha :{{=}}: Red"}}
 +
[[player]] [[sideChat]] "lalala"; {{cc|Alpha :{{=}}: Red (KK): "lalala"}}</code>
  
In [[Armed Assault]] you're able to define the callsignletter by yourself. This can be for example "Fireteam", or "Specialforces".
+
|x3= '''{{arma1}} / {{arma2}} / {{arma3}}''': <code>_group1 [[setGroupId]] ["Assault Squad"];</code>
  
this setgroupId ["Attackteam"]
+
|x4= '''{{ofp}}''': <code>_group1 [[setGroupId]] ["Delta", "GroupColor4"]</code>
</dd>
 
<dd class="notedate"></dd>
 
<dt class="note">'''[[User:Ceeeb|Ceeeb]]'''</dt>
 
<dd class="note">
 
In '''OFP v1.96''', the radio callsign strings for a mission can be redefined  by creating a [[Stringtable.csv_File_Format|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.
 
  
</dd>
+
|seealso= [[setGroupIdGlobal]], [[groupId]], [[group]]
<!-- Note Section END -->
+
}}
</dl>
 
  
<h3 style="display:none">Bottom Section</h3>
+
<dl class="command_description">
  
 +
<dt><dt>
 +
<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]] [[Magic Variables#x|_x]] - 1 [[do]] {
 +
[[diag_log]] ('* ""' + [[configName]] (_x [[select]] _i) + '"" → ' + [[getText]] (([[Magic Variables#x|_x]] [[select]] _i) >> 'name'));
 +
};
 +
}; [[false]]" [[configClasses]] ([[configFile]] >> "CfgWorlds");</code>
 +
</dd>
  
[[Category:Scripting Commands|SETGROUPID]]
+
</dl>
[[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}}}}]]
 

Latest revision as of 23:45, 16 June 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 (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).
Arma 3
Possible Arma 3 values: Show text
Since Armed Assault, 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: Show text

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, 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:
Armed Assault / Arma 2 / Arma 3: _group1 setGroupId ["Assault Squad"];
Example 4:
Operation Flashpoint: _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
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");