hcGroupParams: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
(add. ArmA2 classification)
 
m (Text replacement - "\|x([0-9])= *<code>([^<]*)<\/code>" to "|x$1= <sqf>$2</sqf>")
 
(58 intermediate revisions by 7 users not shown)
Line 1: Line 1:
{{RV|type=command


[[Category:Scripting Commands ArmA2|{{uc:{{PAGENAME}}}}]]
|game1= arma2
|version1= 1.00
 
|game2= arma2oa
|version2= 1.50
 
|game3= tkoh
|version3= 1.00
 
|game4= arma3
|version4= 0.50
 
|gr1= High Command
 
|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:
* {{hl|"teammain"}} (default)
* {{hl|"teamred"}}
* {{hl|"teamgreen"}}
* {{hl|"teamblue"}}
* {{hl|"teamyellow"}}
 
|s1= unit [[hcGroupParams]] group
 
|p1= unit: [[Object]] - commander
 
|p2= group: [[Group]]
 
|r1= [[Array]]
 
|x1= <sqf>player hcGroupParams someGroup;</sqf>
 
|seealso= [[High Command]] [[hcAllGroups]] [[hcLeader]] [[hcRemoveAllGroups]] [[hcRemoveGroup]] [[hcSelected]] [[hcSelectGroup]] [[hcSetGroup]] [[hcShowBar]] [[hcShownBar]] [[onHCGroupSelectionChanged]]
}}

Latest revision as of 11:23, 13 May 2022

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 Command hcAllGroups hcLeader hcRemoveAllGroups hcRemoveGroup hcSelected hcSelectGroup hcSetGroup hcShowBar hcShownBar onHCGroupSelectionChanged

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