setGroupId: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
No edit summary
m (template:command argument fix)
(44 intermediate revisions by 17 users not shown)
Line 1: Line 1:
back to [[Scripting_Reference#S|COMREF]]
{{Command|= Comments
____________________________________________________________________________________________


<h2 style="color:#000066">'''''group'' setGroupId ''id'''''</h2>
| ofp |= Game name


|1.00|= Game version


'''Operand types:'''
|arg= global |Multiplayer Arguments=


'''group:''' [[Object or Group]]
|eff= local |Multiplayer Effects=
____________________________________________________________________________________________


'''id:''' [[Array]]
| 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:
<code>group1 <nowiki>=</nowiki> [[createGroup]] [[west]];
group2 <nowiki>=</nowiki> [[createGroup]] [[west]];


'''Type of returned value:'''
group1 [[setGroupId]] ["Active Group"];
group2 [[setGroupId]] ["Inactive Group"];


[[Nothing]]
[[systemChat]] [[groupId]] group1; //"Active Group";
[[systemChat]] [[groupId]] group2; //"Inactive Group";


'''Description:'''
group2 [[setGroupId]] ["Active Group"];


Set '''group identity'''.
[[systemChat]] [[groupId]] group1; //"Inactive Group";
[[systemChat]] [[groupId]] group2; //"Active Group";</code>


'''Id''' format is '''''[letter, color, picture]''''' or '''''[letter, color]'''''.<br>
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:
'''Letter''' is one of:
<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=
}}
<h3 style="display:none">Notes</h3>
<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:
* '''"Alpha"'''
* '''"Alpha"'''
* '''"Bravo"'''
* '''"Bravo"'''
Line 30: Line 138:
* '''"Hotel"'''
* '''"Hotel"'''
* '''"Kilo"'''
* '''"Kilo"'''
* '''"Yankee"'''


'''Colour''' can be one of "GroupColor0" to "GroupColor7".
* '''"Zulu"'''
* '''"Buffalo"'''
* '''"Convoy"'''
* '''"Guardian"'''
* '''"November"'''
* '''"Two"'''
* '''"Three"'''
* '''"Fox"'''
 
Colour may be one of the following:
* '''"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]]:


'''Example:'''
grp1 <nowiki>=</nowiki> [[group]] this


group1 '''setGroupId''' ["Delta","GroupColor4"]


<dd class="notedate">Posted on December 9, 2006 - 12:20
<dt class="note">'''[[User:Mondkalb|Mondkalb]]'''<dd class="note">''Selfdefined Callsigns:''


'''Comments:'''
In [[Armed Assault]] you're able to define the callsignletter by yourself. This can be for example "Fireteam", or "Specialforces".


Additional values for '''letter''' are:
this setgroupId ["Attackteam"]


* '''"Yankee"'''
<dd class="notedate">
* '''"Zulu"'''
<dt class="note">'''[[User:Ceeeb|Ceeeb]]'''
* '''"Buffalo"'''
<dd class="note">
* '''"Convoy"'''
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.
* '''"Guardian"'''
* '''"November"'''
* '''"Two"'''
* '''"Three"'''


'''Color''' can also be set to '''"Six"'''.


Following is a list of GroupColors:
<!-- Note Section END -->
</dl>


* '''0''' - No colour
<h3 style="display:none">Bottom Section</h3>
* '''1''' - Black
* '''2''' - Red
* '''3''' - Green
* '''4''' - Blue
* '''5''' - Yellow
* '''6''' - Orange
* '''7''' - Pink


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]]:
[[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}}}}]]


grp1 = [[group]] '''this'''
<!-- 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 -->

Revision as of 12:13, 5 August 2019

Hover & click on the images for description

Description

Description:
Sets a group's identity, how it will be displayed in chat, for example. While groups on the different 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: group1 = createGroup west; group2 = createGroup west; group1 setGroupId ["Active Group"]; group2 setGroupId ["Inactive Group"]; systemChat groupId group1; //"Active Group"; systemChat groupId group2; //"Inactive Group"; group2 setGroupId ["Active Group"]; systemChat groupId group1; //"Inactive Group"; systemChat groupId group2; //"Active Group"; 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:

%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.
Groups:
Uncategorised

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:
OFP:_group1 setGroupId ["Delta","GroupColor4"]
Example 4:
ArmA / ArmA 2:_group1 setGroupId ["Assault Squad"]

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

Notes

In OFP, group ID format must be [letter, color, picture] or [letter, color]. Letter is one of:
  • "Alpha"
  • "Bravo"
  • "Charlie"
  • "Delta"
  • "Echo"
  • "Foxtrot"
  • "Golf"
  • "Hotel"
  • "Kilo"
  • "Yankee"
  • "Zulu"
  • "Buffalo"
  • "Convoy"
  • "Guardian"
  • "November"
  • "Two"
  • "Three"
  • "Fox"
Colour may be one of the following:
  • "GroupColor0" - (Nothing)
  • "GroupColor1" - Black
  • "GroupColor2" - Red
  • "GroupColor3" - Green
  • "GroupColor4" - Blue
  • "GroupColor5" - Yellow
  • "GroupColor6" - Orange
  • "GroupColor7" - Pink
  • "Six" - Six
Posted on August 4, 2006 - 11:01
hardrock
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: grp1 = group this
Posted on December 9, 2006 - 12:20
Mondkalb
Selfdefined Callsigns: In Armed Assault you're able to define the callsignletter by yourself. This can be for example "Fireteam", or "Specialforces". this setgroupId ["Attackteam"]
Ceeeb
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.

Bottom Section

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");