hcSetGroup: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "_{10,} " to "")
m (Text replacement - " *\| *([Cc]omments|COMMENTS|Game|[Gg]ame [Nn]ame|Game [Vv]ersion|Game Version \(number surrounded by NO SPACES\)|Multiplayer Arguments( \("local" or "global"\))?|Effects|Multiplayer Effects( \("local" or "global"\))?|Multiplayer Exe...)
Line 1: Line 1:
{{Command|Comments=
{{Command


| arma2 |Game name=
| arma2


|1.00|Game version=
|1.00


|gr1= High Command |GROUP1=
|gr1= High Command


| Add group to unit's [[High Command|high command]] bar.
| Add group to unit's [[High Command|high command]] bar.


{{Informative|The previous HC leader should be [[hcRemoveGroup|removed]] before adding the new one (see '''[[#Examples|Example 3]]''').}} |DESCRIPTION=
{{Informative|The previous HC leader should be [[hcRemoveGroup|removed]] before adding the new one (see '''[[#Examples|Example 3]]''').}}


| unit '''hcSetGroup''' [group, groupName, team] |SYNTAX=
| unit '''hcSetGroup''' [group, groupName, team]


|p1= unit: [[Object]] - the leader |PARAMETER1=
|p1= unit: [[Object]] - the leader


|p2= group: [[Group]] |PARAMETER2=
|p2= group: [[Group]]


|p3= groupName: [[String]] - (Optional) |PARAMETER3=
|p3= groupName: [[String]] - (Optional)


|p4= team: [[String]] - (Optional, default "teamMain") can be one of:
|p4= team: [[String]] - (Optional, default "teamMain") can be one of:
Line 24: Line 24:
* "teamGreen"
* "teamGreen"
* "teamBlue"
* "teamBlue"
* "teamYellow" |PARAMETER4=
* "teamYellow"


| [[Nothing]] |RETURNVALUE=
| [[Nothing]]


|x1= <code>unit [[hcSetGroup]] [group, "HQ", "teamred"];</code>|EXAMPLE1=
|x1= <code>unit [[hcSetGroup]] [group, "HQ", "teamred"];</code>


|x2= <code>[[player]] [[hcSetGroup]] [group];</code>|EXAMPLE2=
|x2= <code>[[player]] [[hcSetGroup]] [group];</code>


|x3= <code>[[if]] ([[player]] !{{=}} [[hcLeader]] _group) [[then]]
|x3= <code>[[if]] ([[player]] !{{=}} [[hcLeader]] _group) [[then]]
Line 36: Line 36:
[[hcLeader]] _group [[hcRemoveGroup]] _group;
[[hcLeader]] _group [[hcRemoveGroup]] _group;
[[player]] [[hcSetGroup]] [_group];
[[player]] [[hcSetGroup]] [_group];
};</code> | EXAMPLE3=
};</code>


| [[High Command]],[[hcAllGroups]],[[hcGroupParams]],[[hcLeader]],[[hcRemoveAllGroups]],[[hcRemoveGroup]],[[hcSelected]],[[hcSelectGroup]],[[hcShowBar]],[[hcShownBar]],[[onHCGroupSelectionChanged]] |SEEALSO=
| [[High Command]],[[hcAllGroups]],[[hcGroupParams]],[[hcLeader]],[[hcRemoveAllGroups]],[[hcRemoveGroup]],[[hcSelected]],[[hcSelectGroup]],[[hcShowBar]],[[hcShownBar]],[[onHCGroupSelectionChanged]]


|  |MPBEHAVIOUR=  
|  |MPBEHAVIOUR=  

Revision as of 00:43, 18 January 2021

Hover & click on the images for description

Description

Description:
Add group to unit's high command bar.
The previous HC leader should be removed before adding the new one (see Example 3).
Groups:
High Command

Syntax

Syntax:
unit hcSetGroup [group, groupName, team]
Parameters:
unit: Object - the leader
group: Group
groupName: String - (Optional)
team: String - (Optional, default "teamMain") can be one of:
  • "teamMain"
  • "teamRed"
  • "teamGreen"
  • "teamBlue"
  • "teamYellow"
Return Value:
Nothing

Examples

Example 1:
unit hcSetGroup [group, "HQ", "teamred"];
Example 2:
player hcSetGroup [group];
Example 3:
if (player != hcLeader _group) then { hcLeader _group hcRemoveGroup _group; player hcSetGroup [_group]; };

Additional Information

See also:
High CommandhcAllGroupshcGroupParamshcLeaderhcRemoveAllGroupshcRemoveGrouphcSelectedhcSelectGrouphcShowBarhcShownBaronHCGroupSelectionChanged

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

Notes

Bottom Section