hcGroupParams: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "\[\[Category:[ _]?Scripting[ _]Commands[ _]Take[ _]On[ _]Helicopters(\|.*)?\]\]" to "{{GameCategory|tkoh|Scripting Commands}}")
m (Text replacement - "\|x([0-9])= *<code>([^<]*)<\/code>" to "|x$1= <sqf>$2</sqf>")
 
(36 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Command|Comments=
{{RV|type=command
____________________________________________________________________________________________


| arma2 |Game name=
|game1= arma2
|version1= 1.00


|1.00|Game version=
|game2= arma2oa
|version2= 1.50


|gr1= High Command |GROUP1=
|game3= tkoh
____________________________________________________________________________________________
|version3= 1.00


| 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:
|game4= arma3
* <tt>"teammain"</tt> (default)
|version4= 0.50
* <tt>"teamred"</tt>
* <tt>"teamgreen"</tt>
* <tt>"teamblue"</tt>
* <tt>"teamyellow"</tt>


|DESCRIPTION=
|gr1= High Command
____________________________________________________________________________________________


| unit '''hcGroupParams''' group |SYNTAX=
|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"}}


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


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


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


| [[Array]] |RETURNVALUE=
|r1= [[Array]]


|x1= <sqf>player hcGroupParams someGroup;</sqf>


|x1= <code>[[player]] [[hcGroupParams]] someGroup;</code>|EXAMPLE1=
|seealso= [[High Command]] [[hcAllGroups]] [[hcLeader]] [[hcRemoveAllGroups]] [[hcRemoveGroup]] [[hcSelected]] [[hcSelectGroup]] [[hcSetGroup]] [[hcShowBar]] [[hcShownBar]] [[onHCGroupSelectionChanged]]
 
____________________________________________________________________________________________
 
| [[High Command]],[[hcAllGroups]],[[hcLeader]], [[hcRemoveAllGroups]], [[hcRemoveGroup]], [[hcSelected]], [[hcSelectGroup]], [[hcSetGroup]], [[hcShowBar]], [[hcShownBar]], [[onHCGroupSelectionChanged]] |SEEALSO=
 
|  |MPBEHAVIOUR=
____________________________________________________________________________________________
}}
}}
<h3 style='display:none'>Notes</h3>
<dl class='command_description'>
<!-- Note Section BEGIN -->
<!-- Note Section END -->
</dl>
<h3 style='display:none'>Bottom Section</h3>
{{GameCategory|arma2|Scripting Commands}}
{{GameCategory|arma3|Scripting Commands}}
{{GameCategory|tkoh|Scripting Commands}}
[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]

Latest revision as of 10:23, 13 May 2022

Logo A2.png1.00A2 OA Logo.png1.50tkoh logo small.png1.00Arma 3 logo black.png0.50
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
Retrieved from "https://community.bistudio.com/wiki?title=hcGroupParams&oldid=319122"