setGroupId: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
mNo edit summary
(description example)
Line 11: Line 11:
____________________________________________________________________________________________
____________________________________________________________________________________________


| Set a group's identity.  
| Sets a group's identity, how it will be displayed in chat, for example. The identity setup consists 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:
<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
 
|= Description
|= Description
____________________________________________________________________________________________
____________________________________________________________________________________________


| group '''setGroupId''' [nameFomat, nameParam1, ...] |= Syntax
| group '''setGroupId''' [nameFormat, nameParam1, ...] |= Syntax


|p1= group: [[Object]] or [[Group]] |= Parameter 1
|p2= group: [[Object]] or [[Group]] |= Parameter 1


|p2= [nameFomat, nameParam1 ...]: [[Array]] of strings. |= Parameter 2
|p3= [nameFormat, nameParam1 ...]: [[Array]] |= Parameter 2
|p4= nameFormat: [[String]] - format template (%keyword1 - %keyword2...etc) |= Parameter 2
|p5= nameParam1 : [[String]] - param keyword |= Parameter 2


| [[Nothing]] |= Return value
| [[Nothing]] |= Return value
____________________________________________________________________________________________
____________________________________________________________________________________________
   
   
|x1= '''OFP''':<code>_group1 [[setGroupId]] ["Delta","GroupColor4"]</code> |= Example 1
|x1= '''Arma 3''':<code>[[group]] [[player]] [[setGroupId]] ["%GroupNames :=: %GroupColors","Alpha","GroupColor2"];
|x2= '''ArmA / ArmA 2''':<code>_group1 [[setGroupId]] ["Assault Squad"]</code> |= Example 2
[[hint]] [[groupId]] [[group]] [[player]]; //"Alpha :=: Red"
[[player]] [[sideChat]] "lalala"; //Alpha :=: Red (KK): "lalala"</code>|= Example 1
|x2= '''OFP''':<code>_group1 [[setGroupId]] ["Delta","GroupColor4"]</code> |= Example 2
|x3= '''ArmA / ArmA 2''':<code>_group1 [[setGroupId]] ["Assault Squad"]</code> |= Example 3
____________________________________________________________________________________________
____________________________________________________________________________________________


| [[groupID]], [[group]] |= See also
| [[groupId]], [[group]] |= See also


}}
}}

Revision as of 01:04, 22 April 2015

Hover & click on the images for description

Description

Description:
Sets a group's identity, how it will be displayed in chat, for example. The identity setup consists 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
Groups:
Uncategorised

Syntax

Syntax:
group setGroupId [nameFormat, nameParam1, ...]
Return Value:
Nothing

Examples

Example 1:
Arma 3:group player setGroupId ["%GroupNames :=: %GroupColors","Alpha","GroupColor2"]; hint groupId group player; //"Alpha :=: Red" player sideChat "lalala"; //Alpha :=: Red (KK): "lalala"
Example 2:
OFP:_group1 setGroupId ["Delta","GroupColor4"]
Example 3:
ArmA / ArmA 2:_group1 setGroupId ["Assault Squad"]

Additional Information

See also:
groupIdgroup

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