onHCGroupSelectionChanged: Difference between revisions

Latest revision as of 19:43, 3 September 2024

1.00

1.50

1.00

0.50

Hover & click on the images for description

Description

Description:

Defines an action performed when high command group selection has been changed.
Command receives 2 variables:

_group: Group - last selected/deselected group
_isSelected: Boolean - new selection state of the specific group

The code is executed on every hc group selection change until it is replaced or removed (see Example 3).

⚠

Using the command again will overwrite the previously set code.

ⓘ

Since Arma 3 v1.58 a stackable version of this EH is available: HCGroupSelectionChanged

Groups:

High Command Event Handlers

Syntax

Syntax:: onHCGroupSelectionChanged code
Parameters:: code: String or Code
Return Value:: Nothing

Examples

Example 1:: onHCGroupSelectionChanged { if (_isSelected) then { hint format ["Group %1 has been selected.", _group]; } else { hint format ["Group %1 has been deselected.", _group]; }; };
Example 2:: onHCGroupSelectionChanged "player globalChat 'HC group selection has been changed.';";
Example 3:: Remove event handler:
onHCGroupSelectionChanged ""; // or onHCGroupSelectionChanged {};

Additional Information

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

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

@@ Line 20: / Line 20: @@
 * _group: [[Group]] - last selected/deselected group
 * _isSelected: [[Boolean]] - new selection state of the specific group
-The code is executed on every [[High Command|hc]] group selection change until it is replaced or removed (see {{HashLink|#Example 3}}).
+The code is executed on every [[High Command|hc]] group selection change until it is replaced or removed (see {{Link|#Example 3}}).
 {{Feature|important|Using the command again will '''overwrite''' the previously set code.}}
-{{Feature|Informative|Since {{arma3}} v1.58 a stackable version of this EH is available: [[Arma 3: Mission Event Handlers#HCGroupSelectionChanged|HCGroupSelectionChanged]]}}
+{{Feature|informative|Since {{arma3}} v1.58 a stackable version of this EH is available: [[Arma 3: Mission Event Handlers#HCGroupSelectionChanged|HCGroupSelectionChanged]]}}
 |s1= [[onHCGroupSelectionChanged]] code
@@ Line 30: / Line 30: @@
 |r1= [[Nothing]]
-|x1= <code>[[onHCGroupSelectionChanged]] {
+|x1= <sqf>
-	[[if]] (_isSelected) [[then]]
+onHCGroupSelectionChanged {
+	if (_isSelected) then
 	{
-		[[hint]] [[format]] ["Group %1 has been selected.", _group];
+		hint format ["Group %1 has been selected.", _group];
 	}
-	[[else]]
+	else
 	{
-		[[hint]] [[format]] ["Group %1 has been deselected.", _group];
+		hint format ["Group %1 has been deselected.", _group];
 	};
-};</code>
+};
+</sqf>
-|x2= <code>[[onHCGroupSelectionChanged]] "[[player]] [[globalChat]] 'HC group selection has been changed.';";</code>
+|x2= <sqf>onHCGroupSelectionChanged "player globalChat 'HC group selection has been changed.';";</sqf>
-|x3= Remove event handler:<code>[[onHCGroupSelectionChanged]] "";
+|x3= Remove event handler:
-{{cc|or}}
+<sqf>
-[[onHCGroupSelectionChanged]] {};</code>
+onHCGroupSelectionChanged "";
+// or
+onHCGroupSelectionChanged {};
+</sqf>
-|seealso= [[High Command]] [[hcAllGroups]] [[hcGroupParams]] [[hcLeader]] [[hcRemoveAllGroups]] [[hcRemoveGroup]] [[hcSelected]] [[hcSelectGroup]], [[hcSetGroup]], [[hcShowBar]], [[hcShownBar]], [[onCommandModeChanged]]
+|seealso= [[High Command]] [[hcAllGroups]] [[hcGroupParams]] [[hcLeader]] [[hcRemoveAllGroups]] [[hcRemoveGroup]] [[hcSelected]] [[hcSelectGroup]] [[hcSetGroup]] [[hcShowBar]] [[hcShownBar]] [[onCommandModeChanged]]
 }}