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 1: / Line 1: @@
-{{Command
+{{RV|type=command
-| arma2
+|game1= arma2
+|version1= 1.00
-|1.00
+|game2= arma2oa
+|version2= 1.50
+|game3= tkoh
+|version3= 1.00
+|game4= arma3
+|version4= 0.50
 |gr1= High Command
 |gr2= Event Handlers
-| Defines an action performed when [[High Command|high command]] group selection has been changed.
+|descr= Defines an action performed when [[High Command|high command]] group selection has been changed.<br>
-<br>
 Command receives 2 variables:
-*_group: [[Group]] - last selected/deselected group
+* _group: [[Group]] - last selected/deselected group
-*_isSelected: [[Boolean]] - new selection state of the specific 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 {{Link|#Example 3}}).
-The code is executed on every [[High Command|hc]] group selection change until it is
+{{Feature|important|Using the command again will '''overwrite''' the previously set code.}}
-* removed via <code>[[onHCGroupSelectionChanged]] "";</code> or <code>[[onHCGroupSelectionChanged]] {};</code>
+{{Feature|informative|Since {{arma3}} v1.58 a stackable version of this EH is available: [[Arma 3: Mission Event Handlers#HCGroupSelectionChanged|HCGroupSelectionChanged]]}}
-* or replaced by <code>[[onHCGroupSelectionChanged]] "SomeOtherCommand(s)";</code> or <code>[[onHCGroupSelectionChanged]] {SomeOtherCommand(s)};</code>
-{{Informative|Since '''Arma 3''' ''v1.57'' a stackable version of this EH is available: [[Arma_3:_Event_Handlers/addMissionEventHandler#HCGroupSelectionChanged|HCGroupSelectionChanged]]}}
-| '''onHCGroupSelectionChanged''' command
+|s1= [[onHCGroupSelectionChanged]] code
-|p1= command: [[String]] or [[Code]]
+|p1= code: [[String]] or [[Code]]
-|p2=
+|r1= [[Nothing]]
-|p3=
+|x1= <sqf>
+onHCGroupSelectionChanged {
+	if (_isSelected) then
+	{
+		hint format ["Group %1 has been selected.", _group];
+	}
+	else
+	{
+		hint format ["Group %1 has been deselected.", _group];
+	};
+};
+</sqf>
-| [[Nothing]]
+|x2= <sqf>onHCGroupSelectionChanged "player globalChat 'HC group selection has been changed.';";</sqf>
-|x1= <code>[[onHCGroupSelectionChanged]] {
+|x3= Remove event handler:
-  [[if]] (_isSelected) [[then]] {
+<sqf>
-    [[hint]] [[format]] ["Group %1 has been selected.", _group];
+onHCGroupSelectionChanged "";
-  } [[else]] {
+// or
-    [[hint]] [[format]] ["Group %1 has been deselected.", _group];
+onHCGroupSelectionChanged {};
-  };
+</sqf>
-};</code>
-|x2= <code>[[onHCGroupSelectionChanged]] "[[player]] [[globalChat]] 'HC group selection has been changed.';";</code>
+|seealso= [[High Command]] [[hcAllGroups]] [[hcGroupParams]] [[hcLeader]] [[hcRemoveAllGroups]] [[hcRemoveGroup]] [[hcSelected]] [[hcSelectGroup]] [[hcSetGroup]] [[hcShowBar]] [[hcShownBar]] [[onCommandModeChanged]]
-| [[High Command]], [[hcAllGroups]], [[hcGroupParams]], [[hcLeader]], [[hcRemoveAllGroups]], [[hcRemoveGroup]], [[hcSelected]], [[hcSelectGroup]], [[hcSetGroup]], [[hcShowBar]], [[hcShownBar]], [[onCommandModeChanged]]
 }}
-{{GameCategory|arma2|Scripting Commands}}
-{{GameCategory|arma3|Scripting Commands}}
-{{GameCategory|tkoh|Scripting Commands}}
-[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]