onHCGroupSelectionChanged: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Added to "see also" + wikilinking. Still needs example. Description is unintelligible.)
(added description, added example)
Line 7: Line 7:
____________________________________________________________________________________________
____________________________________________________________________________________________


| Defines an action performed when [[High Command|high command]] group has been selected.
| Defines an action performed when [[High Command|high command]] group selection has been changed.
<br>
<br>
Command receives, _group group selected group, _isSelected bool new selection state |= Description
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
* removed via <code>[[onHCGroupSelectionChanged]] "";</code> or <code>[[onHCGroupSelectionChanged]] {};</code>
* or replaced by <code>[[onHCGroupSelectionChanged]] "SomeOtherCommand(s)";</code> or <code>[[onHCGroupSelectionChanged]] {SomeOtherCommand(s)};</code>
 
|= Description
____________________________________________________________________________________________
____________________________________________________________________________________________


| '''onHCGroupSelectionChanged''' command |= Syntax
| '''onHCGroupSelectionChanged''' command |= Syntax


|p1= command: |= PARAMETER1  
|p1= command: [[String]] or [[Code]] |= PARAMETER1  


|p2= |= PARAMETER2  
|p2= |= PARAMETER2  
Line 20: Line 28:
|p3= |= PARAMETER3  
|p3= |= PARAMETER3  


| Nothing |= RETURNVALUE  
| [[Nothing]] |= RETURNVALUE  
 


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


|x1= <code>(example)</code>|= EXAMPLE1
|x2= <code>[[onHCGroupSelectionChanged]] "[[player]] [[globalChat]] 'HC group selection has been changed.';";</code>|= EXAMPLE2


____________________________________________________________________________________________
____________________________________________________________________________________________

Revision as of 10:56, 22 March 2014

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
Groups:
Uncategorised

Syntax

Syntax:
onHCGroupSelectionChanged command
Parameters:
command: 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.';";

Additional Information

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

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

Notes

Bottom Section