hcGroupParams: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - " +" to " ")
m (Text replacement - "\|s([0-9])\= ([^' ]+)'''([^' ]+)'''([^ ]*) " to "|s$1= $2$3$4 ")
(6 intermediate revisions by the same user not shown)
Line 1: Line 1:
{{RV|type=command
{{RV|type=command


| arma2
|game1= arma2
|1.00
|version1= 1.00


|game2= arma2oa
|game2= arma2oa
Line 15: Line 15:
|gr1= High Command
|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:
|descr= 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:
* <tt>"teammain"</tt> (default)
* <tt>"teammain"</tt> (default)
* <tt>"teamred"</tt>
* <tt>"teamred"</tt>
Line 22: Line 22:
* <tt>"teamyellow"</tt>
* <tt>"teamyellow"</tt>


| unit '''hcGroupParams''' group
|s1= unit [[hcGroupParams]] group


|p1= unit: [[Object]] - commander
|p1= unit: [[Object]] - commander
Line 34: Line 34:
|seealso= [[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]]
}}
}}
{{GameCategory|arma2|Scripting Commands}}
{{GameCategory|arma3|Scripting Commands}}
{{GameCategory|tkoh|Scripting Commands}}

Revision as of 18:58, 20 June 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 - commander
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