hcGroupParams: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "_{10,} " to "")
m (Text replacement - " *\| *([Cc]omments|COMMENTS|Game|[Gg]ame [Nn]ame|Game [Vv]ersion|Game Version \(number surrounded by NO SPACES\)|Multiplayer Arguments( \("local" or "global"\))?|Effects|Multiplayer Effects( \("local" or "global"\))?|Multiplayer Exe...)
Line 1: Line 1:
{{Command|Comments=
{{Command


| arma2 |Game name=
| arma2


|1.00|Game version=
|1.00


|gr1= High Command |GROUP1=
|gr1= High Command


| Returns parameters describing group in [[High Command|high command]] bar. Return value is array in format [groupName, teamName] or [] if error. Possible values for team name:
| Returns parameters describing group in [[High Command|high command]] bar. Return value is array in format [groupName, teamName] or [] if error. Possible values for team name:
Line 14: Line 14:
* <tt>"teamyellow"</tt>
* <tt>"teamyellow"</tt>


|DESCRIPTION=


| unit '''hcGroupParams''' group |SYNTAX=


|p1= unit: [[Object]] -  |PARAMETER1=
| unit '''hcGroupParams''' group


|p2= group: [[Group]] - |PARAMETER2=
|p1= unit: [[Object]] -


|p3= |PARAMETER3=  
|p2= group: [[Group]] -


| [[Array]] |RETURNVALUE=  
|p3=


| [[Array]]


|x1= <code>[[player]] [[hcGroupParams]] someGroup;</code>|EXAMPLE1=


|x1= <code>[[player]] [[hcGroupParams]] someGroup;</code>


| [[High Command]],[[hcAllGroups]],[[hcLeader]], [[hcRemoveAllGroups]], [[hcRemoveGroup]], [[hcSelected]], [[hcSelectGroup]], [[hcSetGroup]], [[hcShowBar]], [[hcShownBar]], [[onHCGroupSelectionChanged]] |SEEALSO=
 
| [[High Command]],[[hcAllGroups]],[[hcLeader]], [[hcRemoveAllGroups]], [[hcRemoveGroup]], [[hcSelected]], [[hcSelectGroup]], [[hcSetGroup]], [[hcShowBar]], [[hcShownBar]], [[onHCGroupSelectionChanged]]


|  |MPBEHAVIOUR=  
|  |MPBEHAVIOUR=  

Revision as of 01:42, 18 January 2021

Hover & click on the images for description

Description

Description:
Returns parameters describing group in high command bar. Return value is array in format [groupName, teamName] or [] if error. Possible values for team name:
  • "teammain" (default)
  • "teamred"
  • "teamgreen"
  • "teamblue"
  • "teamyellow"
Groups:
High Command

Syntax

Syntax:
unit hcGroupParams group
Parameters:
unit: Object -
group: Group -
Return Value:
Array

Examples

Example 1:
player hcGroupParams someGroup;

Additional Information

See also:
High CommandhcAllGroupshcLeaderhcRemoveAllGroupshcRemoveGrouphcSelectedhcSelectGrouphcSetGrouphcShowBarhcShownBaronHCGroupSelectionChanged

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

Bottom Section