Difference between revisions of "hcGroupParams"

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Added to "see also" + wikilinking. Still needs example.)
m (Text replacement - "Category:Scripting Commands ArmA2" to "Category:Scripting Commands Arma 2")
(9 intermediate revisions by 5 users not shown)
Line 1: Line 1:
{{Command|= Comments
+
{{Command|Comments=
 
____________________________________________________________________________________________
 
____________________________________________________________________________________________
  
| arma2 |= Game name
+
| arma2 |Game name=
  
|1.00|= Game version
+
|1.00|Game version=
 
____________________________________________________________________________________________
 
____________________________________________________________________________________________
  
| Returns parameters describing group in [[High Command|high command]] bar.
+
| 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:
<br>
+
* <tt>"teammain"</tt> (default)
Return value is [string, float[4]] |= Description
+
* <tt>"teamred"</tt>
 +
* <tt>"teamgreen"</tt>
 +
* <tt>"teamblue"</tt>
 +
* <tt>"teamyellow"</tt>
 +
 
 +
|DESCRIPTION=
 
____________________________________________________________________________________________
 
____________________________________________________________________________________________
  
| unit '''hcGroupParams''' group |= Syntax
+
| unit '''hcGroupParams''' group |SYNTAX=
  
|p1= unit: [[Object]] -  |= PARAMETER1
+
|p1= unit: [[Object]] -  |PARAMETER1=  
  
|p2= group: [[Group]] -  |= PARAMETER2
+
|p2= group: [[Group]] -  |PARAMETER2=  
  
|p3= |= PARAMETER3
+
|p3= |PARAMETER3=  
  
| [[Array]] |= RETURNVALUE
+
| [[Array]] |RETURNVALUE=  
  
  
|x1= <code>(example)</code>|= EXAMPLE1
+
|x1= <code>[[player]] [[hcGroupParams]] someGroup;</code>|EXAMPLE1=  
  
 
____________________________________________________________________________________________
 
____________________________________________________________________________________________
  
| [[High Command]],  
+
| [[High Command]],[[hcAllGroups]],[[hcLeader]], [[hcRemoveAllGroups]], [[hcRemoveGroup]], [[hcSelected]], [[hcSelectGroup]], [[hcSetGroup]], [[hcShowBar]], [[hcShownBar]], [[onHCGroupSelectionChanged]] |SEEALSO=  
[[hcAllGroups]],  
 
[[hcLeader]],  
 
[[hcRemoveAllGroups]],  
 
[[hcRemoveGroup]],  
 
[[hcSelected]],  
 
[[hcSelectGroup]],  
 
[[hcSetGroup]],  
 
[[hcShowBar]],  
 
[[hcShownBar]] |= SEEALSO
 
  
|  |= MPBEHAVIOUR
+
|  |MPBEHAVIOUR=  
 
____________________________________________________________________________________________
 
____________________________________________________________________________________________
 
}}
 
}}
Line 50: Line 46:
  
 
<h3 style='display:none'>Bottom Section</h3>
 
<h3 style='display:none'>Bottom Section</h3>
[[Category:ArmA 2: New Scripting Commands List|{{uc:{{PAGENAME}}}}]]
+
 
[[Category:Scripting Commands ArmA2|{{uc:{{PAGENAME}}}}]]
+
[[Category:Scripting Commands Arma 2|{{uc:{{PAGENAME}}}}]]
 
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
 
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
 
[[Category:Scripting_Commands_Take_On_Helicopters|{{uc:{{PAGENAME}}}}]]
 
[[Category:Scripting_Commands_Take_On_Helicopters|{{uc:{{PAGENAME}}}}]]
 
[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]
 
[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]

Revision as of 12:09, 10 January 2020

Introduced with Arma 2 version 1.001.00
Hover & click on the images for descriptions

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"

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

i
Only post proven facts here. Report bugs on the Feedback Tracker and discuss on the Arma Discord or on the Forums.

Notes

Bottom Section