onHCGroupSelectionChanged: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
(populated)
m (Text replacement - "<sqf>([^↵][^<]*↵[^<]*)<\/sqf>" to "<sqf> $1 </sqf>")
 
(79 intermediate revisions by 8 users not shown)
Line 1: Line 1:
{{Command|= Comments
{{RV|type=command
____________________________________________________________________________________________


| arma2 |= Game name
|game1= arma2
|version1= 1.00


|1.00|= Game version
|game2= arma2oa
____________________________________________________________________________________________
|version2= 1.50


| Defines an action performed when HC group has been selected. Command receives,_group group selected group,_isSelected bool new selection state |= Description
|game3= tkoh
____________________________________________________________________________________________
|version3= 1.00


| '''onHCGroupSelectionChanged''' command |= Syntax
|game4= arma3
|version4= 0.50


|p1= command:  -  |= PARAMETER1
|gr1= High Command
|gr2= Event Handlers


|p2= |= PARAMETER2
|descr= Defines an action performed when [[High Command|high command]] group selection has been changed.<br>
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 [[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]]}}


|p3= |= PARAMETER3
|s1= [[onHCGroupSelectionChanged]] code


| Nothing |= RETURNVALUE
|p1= code: [[String]] or [[Code]]


|r1= [[Nothing]]


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


____________________________________________________________________________________________
|x2= <sqf>onHCGroupSelectionChanged "player globalChat 'HC group selection has been changed.';";</sqf>


| |= SEEALSO
|x3= Remove event handler:
<sqf>
onHCGroupSelectionChanged "";
// or
onHCGroupSelectionChanged {};
</sqf>


| |= MPBEHAVIOUR
|seealso= [[High Command]] [[hcAllGroups]] [[hcGroupParams]] [[hcLeader]] [[hcRemoveAllGroups]] [[hcRemoveGroup]] [[hcSelected]] [[hcSelectGroup]] [[hcSetGroup]] [[hcShowBar]] [[hcShownBar]] [[onCommandModeChanged]]
____________________________________________________________________________________________
}}
}}
<h3 style='display:none'>Notes</h3>
<dl class='command_description'>
<!-- Note Section BEGIN -->
<!-- Note Section END -->
</dl>
<h3 style='display:none'>Bottom Section</h3>
[[Category:ArmA 2: New Scripting Commands List|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands ArmA2|{{uc:{{PAGENAME}}}}]]

Latest revision as of 19:43, 3 September 2024

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