hcGroupParams: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "\|( *\[\[[a-zA-Z]+\]\]) * \|x1=" to "\|r1=$1 \|x1=")
m (Text replacement - "\|x([0-9])= *<code>([^<]*)<\/code>" to "|x$1= <sqf>$2</sqf>")
 
(22 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)
* {{hl|"teammain"}} (default)
* <tt>"teamred"</tt>
* {{hl|"teamred"}}
* <tt>"teamgreen"</tt>
* {{hl|"teamgreen"}}
* <tt>"teamblue"</tt>
* {{hl|"teamblue"}}
* <tt>"teamyellow"</tt>
* {{hl|"teamyellow"}}


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


|p1= unit: [[Object]] - commander
|p1= unit: [[Object]] - commander
Line 28: Line 28:
|p2= group: [[Group]]
|p2= group: [[Group]]


\|r1= [[Array]]
|r1= [[Array]]


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


|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}}

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