onHCGroupSelectionChanged: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "\|s([0-9])\= '''([^' ]+)'''([^ ]+) " to "|s$1= $2$3 ")
m (Some wiki formatting)
Line 16: Line 16:
|gr2= Event Handlers
|gr2= Event Handlers


|descr= 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:
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 {{HashLink|#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]]}}


The code is executed on every [[High Command|hc]] group selection change until it is
|s1= [[onHCGroupSelectionChanged]] code
* removed via <code>[[onHCGroupSelectionChanged]] "";</code> or <code>[[onHCGroupSelectionChanged]] {};</code>
* or replaced by <code>[[onHCGroupSelectionChanged]] "SomeOtherCommand(s)";</code> or <code>[[onHCGroupSelectionChanged]] {SomeOtherCommand(s)};</code>
{{Feature|Informative|Since '''Arma 3''' ''v1.57'' a stackable version of this EH is available: [[Arma 3: Mission Event Handlers#HCGroupSelectionChanged|HCGroupSelectionChanged]]}}


|s1= [[onHCGroupSelectionChanged]] command
|p1= code: [[String]] or [[Code]]
 
|p1= command: [[String]] or [[Code]]


|r1= [[Nothing]]
|r1= [[Nothing]]


|x1= <code>[[onHCGroupSelectionChanged]] {
|x1= <code>[[onHCGroupSelectionChanged]] {
  [[if]] (_isSelected) [[then]] {
[[if]] (_isSelected) [[then]]
    [[hint]] [[format]] ["Group %1 has been selected.", _group];
{
  } [[else]] {
[[hint]] [[format]] ["Group %1 has been selected.", _group];
    [[hint]] [[format]] ["Group %1 has been deselected.", _group];
}
  };
[[else]]
{
[[hint]] [[format]] ["Group %1 has been deselected.", _group];
};
};</code>
};</code>


|x2= <code>[[onHCGroupSelectionChanged]] "[[player]] [[globalChat]] 'HC group selection has been changed.';";</code>
|x2= <code>[[onHCGroupSelectionChanged]] "[[player]] [[globalChat]] 'HC group selection has been changed.';";</code>
|x3= Remove event handler:<code>[[onHCGroupSelectionChanged]] "";
{{cc|or}}
[[onHCGroupSelectionChanged]] {};</code>


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

Revision as of 23:01, 21 September 2021

Logo A2.png1.00A2 OA Logo.png1.50tkoh logo small.png1.00Arma 3 logo black.png0.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 CommandEvent 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 CommandhcAllGroupshcGroupParamshcLeaderhcRemoveAllGroupshcRemoveGrouphcSelectedhcSelectGrouphcSetGrouphcShowBarhcShownBaronCommandModeChanged

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
Retrieved from "https://community.bistudio.com/wiki?title=onHCGroupSelectionChanged&oldid=293487"