Difference between revisions of "hcGroupParams"

From Bohemia Interactive Community
Jump to navigation Jump to search
(add. ArmA2 classification)
 
m (Text replacement - "Category:Scripting Commands ArmA2" to "Category:Scripting Commands Arma 2")
 
(15 intermediate revisions by 7 users not shown)
Line 1: Line 1:
 +
{{Command|Comments=
 +
____________________________________________________________________________________________
  
[[Category:Scripting Commands ArmA2|{{uc:{{PAGENAME}}}}]]
+
| arma2 |Game name=
 +
 
 +
|1.00|Game version=
 +
____________________________________________________________________________________________
 +
 
 +
| 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>"teamred"</tt>
 +
* <tt>"teamgreen"</tt>
 +
* <tt>"teamblue"</tt>
 +
* <tt>"teamyellow"</tt>
 +
 
 +
|DESCRIPTION=
 +
____________________________________________________________________________________________
 +
 
 +
| unit '''hcGroupParams''' group |SYNTAX=
 +
 
 +
|p1= unit: [[Object]] -  |PARAMETER1=
 +
 
 +
|p2= group: [[Group]] -  |PARAMETER2=
 +
 
 +
|p3= |PARAMETER3=
 +
 
 +
| [[Array]] |RETURNVALUE=
 +
 
 +
 
 +
|x1= <code>[[player]] [[hcGroupParams]] someGroup;</code>|EXAMPLE1=
 +
 
 +
____________________________________________________________________________________________
 +
 
 +
| [[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>
 +
 
 +
[[Category:Scripting Commands Arma 2|{{uc:{{PAGENAME}}}}]]
 +
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
 +
[[Category:Scripting_Commands_Take_On_Helicopters|{{uc:{{PAGENAME}}}}]]
 +
[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]

Latest revision as of 11: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. Use the Talk page or the Forums for discussions.

Notes

Bottom Section