hcSetGroup: Difference between revisions

Latest revision as of 21:54, 26 September 2024

Hover & click on the images for 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:

unit hcSetGroup [group, groupName, team]

Parameters:

unit: Object - the leader

group: Group

groupName: String - (Optional)

team: String Enum - (Optional, default "teamMain") can be one of:

Return Value:

Nothing

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

See also:: High Command hcAllGroups hcGroupParams hcLeader hcRemoveAllGroups hcRemoveGroup hcSelected hcSelectGroup hcShowBar hcShownBar onHCGroupSelectionChanged

: 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

@@ Line 1: / Line 1: @@
+{{RV|type=command
-[[Category:Scripting Commands ArmA2|{{uc:{{PAGENAME}}}}]]
+|game1= arma2
+|version1= 1.00
+|game2= arma2oa
+|version2= 1.50
+|game3= tkoh
+|version3= 1.00
+|game4= arma3
+|version4= 0.50
+|gr1= High Command
+|descr= Add group to unit's [[High Command|high command]] bar.
+{{Feature|informative|The previous HC leader should be [[hcRemoveGroup|removed]] before adding the new one (see '''{{Link|#Example 3}}''').}}
+|s1= unit [[hcSetGroup]] [group, groupName, team]
+|p1= unit: [[Object]] - the leader
+|p2= group: [[Group]]
+|p3= groupName: [[String]] - (Optional)
+|p4= team: [[String]] Enum - (Optional, default "teamMain") can be one of:
+* "teamMain"
+* "teamRed"
+* "teamGreen"
+* "teamBlue"
+* "teamYellow"
+|r1= [[Nothing]]
+|x1= <sqf>unit hcSetGroup [group, "HQ", "teamred"];</sqf>
+|x2= <sqf>player hcSetGroup [group];</sqf>
+|x3= <sqf>
+if (player != hcLeader _group) then
+{
+	hcLeader _group hcRemoveGroup _group;
+	player hcSetGroup [_group];
+};
+</sqf>
+|seealso= [[High Command]] [[hcAllGroups]] [[hcGroupParams]] [[hcLeader]] [[hcRemoveAllGroups]] [[hcRemoveGroup]] [[hcSelected]] [[hcSelectGroup]] [[hcShowBar]] [[hcShownBar]] [[onHCGroupSelectionChanged]]
+}}