setGroupId: Difference between revisions
Jump to navigation
Jump to search
Lou Montana (talk | contribs) m (Text replacement - "|= Game version" to "|Game version=") |
Lou Montana (talk | contribs) (Liiittle page refresh :^)) |
||
Line 11: | Line 11: | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
| Sets | | 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 | <code>group1 [[setGroupId]] ["Active Group"]; | ||
group2 | 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>}} | |||
{{Informative | From '''{{arma}}''', you can freely decide the callsign, e.g {{Inline code | [[group]] [[player]] [[setGroupId]] ["First Assault Recon Team"];}}.}} | |||
{{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>}} | ||
* " | |||
* | |||
* | |||
* | |||
For global variant of this command | For the global variant of this command see [[setGroupIdGlobal]]. |DESCRIPTION= | ||
|DESCRIPTION= | |||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
| group | | group [[setGroupId]] [nameFormat, nameParam1, ..., nameParamN] |SYNTAX= | ||
|p1= group: [[Object]] or [[Group]] |PARAMETER1= | |p1= group: [[Object]] or [[Group]] |PARAMETER1= | ||
|p2= [nameFormat, nameParam1, ..., nameParamN]: [[Array]] |PARAMETER2= | |p2= [nameFormat, nameParam1, ..., nameParamN]: [[Array]] |PARAMETER2= | ||
|p3= nameFormat: [[String]] - format template (%keyword1 - %keyword2...etc) | | |||
|p4= nameParam1: [[String]] - param keyword | | |p3= nameFormat: [[String]] - format template (%keyword1 - %keyword2...etc) |PARAMETER3= | ||
|p4= nameParam1: [[String]] - param keyword |PARAMETER4= | |||
| [[Nothing]] |RETURNVALUE= | | [[Nothing]] |RETURNVALUE= | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
|x1= ''' | |||
[[hint]] [[groupId]] [[group]] [[player]]; | |x1= '''{{arma3}}''':<code>[[group]] [[player]] [[setGroupId]] ["Some name for the group"]; | ||
[[player]] [[sideChat]] "lalala"; | [[hint]] [[groupId]] [[group]] [[player]]; {{cc|"Some name for the group"}} | ||
|x2= ''' | [[player]] [[sideChat]] "lalala"; {{cc|Some name for the group (KK): "lalala"}}</code> |EXAMPLE1= | ||
[[hint]] [[groupId]] [[group]] [[player]]; | |||
[[player]] [[sideChat]] "lalala"; | |x2= '''{{arma3}}''':<code>[[group]] [[player]] [[setGroupId]] ["%GroupNames :{{=}}: %GroupColors", "Alpha", "GroupColor2"]; | ||
|x3= ''' | [[hint]] [[groupId]] [[group]] [[player]]; {{cc|"Alpha :{{=}}: Red"}} | ||
|x4= ''' | [[player]] [[sideChat]] "lalala"; {{cc|Alpha :{{=}}: Red (KK): "lalala"}}</code> |EXAMPLE2= | ||
|x3= '''ArmA / {{arma2}} / {{arma3}}''': <code>_group1 [[setGroupId]] ["Assault Squad"];</code> |EXAMPLE3= | |||
|x4= '''OFP''': <code>_group1 [[setGroupId]] ["Delta", "GroupColor4"]</code> |EXAMPLE4= | |||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
| [[setGroupIdGlobal]], [[groupId]], [[group]] |SEEALSO= | | [[setGroupIdGlobal]], [[groupId]], [[group]] |SEEALSO= | ||
}} | }} | ||
Line 125: | Line 168: | ||
<dl class="command_description"> | <dl class="command_description"> | ||
<!-- Note Section BEGIN --> | <!-- 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="notedate">Posted on | |||
<dt class="note"> | |||
<dt | |||
<dd class="note"> | <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 --> | <!-- Note Section END --> | ||
Line 186: | Line 186: | ||
[[Category:Scripting Commands| | [[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}}}}]] | [[Category:Scripting Commands OFP 1.99|{{uc:{{PAGENAME}}}}]] | ||
[[Category:Scripting Commands | [[Category:Scripting Commands ArmA|{{uc:{{PAGENAME}}}}]] | ||
[[Category:Scripting Commands ArmA2|{{uc:{{PAGENAME}}}}]] | [[Category:Scripting Commands ArmA2|{{uc:{{PAGENAME}}}}]] | ||
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]] | [[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]] | ||
Line 196: | Line 196: | ||
[[Category:Command_Group:_Groups|{{uc:{{PAGENAME}}}}]] | [[Category:Command_Group:_Groups|{{uc:{{PAGENAME}}}}]] | ||
[[Category:Command_Group:_Object_Manipulation|{{uc:{{PAGENAME}}}}]] | [[Category:Command_Group:_Object_Manipulation|{{uc:{{PAGENAME}}}}]] | ||
Revision as of 21:10, 2 September 2019
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). For the global variant of this command see 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:
- ArmA / Arma 2 / Arma 3:
_group1 setGroupId ["Assault Squad"];
- Example 4:
- OFP:
_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
Notes
- 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");
Bottom Section
Categories:
- Scripting Commands
- Introduced with Operation Flashpoint version 1.00
- Operation Flashpoint: New Scripting Commands
- Operation Flashpoint: Scripting Commands
- Command Group: Uncategorised
- Scripting Commands: Local Effect
- Scripting Commands OFP 1.46
- Scripting Commands OFP 1.96
- Scripting Commands OFP 1.99
- Scripting Commands ArmA
- Scripting Commands ArmA2
- Scripting Commands Arma 3
- Scripting Commands Take On Helicopters
- Command Group: Groups
- Command Group: Object Manipulation