onHCGroupSelectionChanged: Difference between revisions

From Bohemia Interactive Community
mNo edit summary
m (Text replacement - "<sqf>([^↵][^<]*↵[^<]*)<\/sqf>" to "<sqf> $1 </sqf>")
 
(62 intermediate revisions by 2 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


|gr1= High Command |=GROUP1
|game3= tkoh
____________________________________________________________________________________________
|version3= 1.00


| Defines an action performed when [[High Command|high command]] group selection has been changed.
|game4= arma3
<br>
|version4= 0.50
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
|gr1= High Command
* removed via <code>[[onHCGroupSelectionChanged]] "";</code> or <code>[[onHCGroupSelectionChanged]] {};</code>
|gr2= Event Handlers
* 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]]}}|DESCRIPTION=
____________________________________________________________________________________________


| '''onHCGroupSelectionChanged''' command |SYNTAX=
|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]]}}


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


|p2= |PARAMETER2=  
|p1= code: [[String]] or [[Code]]


|p3= |PARAMETER3=  
|r1= [[Nothing]]


| [[Nothing]] |RETURNVALUE=
|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>


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


|x2= <code>[[onHCGroupSelectionChanged]] "[[player]] [[globalChat]] 'HC group selection has been changed.';";</code>|EXAMPLE2=
|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]]|SEEALSO=
 
|  |MPBEHAVIOUR=
____________________________________________________________________________________________
}}
}}
<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:Scripting Commands Arma 2|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands Take On Helicopters|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]

Latest revision as of 19:43, 3 September 2024

Logo A2.png 1.00A2 OA Logo.png 1.50tkoh logo small.png 1.00Arma 3 logo black.png 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 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
Retrieved from "https://community.bistudio.com/wiki?title=onHCGroupSelectionChanged&oldid=369345"