onGroupIconClick: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "[[Category:Scripting_Commands_Take_On_Helicopters" to "[[Category:Scripting Commands Take On Helicopters")
m (Some wiki formatting)
 
(58 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


| Defines an action performed when player clicked on group marker (3D or in a map). The code executed once. This EH, unlike [[onGroupIconOverEnter]] and [[onGroupIconOverLeave]], has one more param which returns 1 if RMB was pressed, 0 otherwise. <br><br>
|game3= tkoh
{{Informative|Since '''Arma 3''' ''v1.57'' a stackable version of this EH is available: [[Arma_3:_Event_Handlers/addMissionEventHandler#GroupIconClick|GroupIconClick]]}} |DESCRIPTION=
|version3= 1.00
____________________________________________________________________________________________


| '''onGroupIconClick''' command |SYNTAX=
|game4= arma3
|version4= 0.50


|p1= command: [[String]] or [[Code]] - script |PARAMETER1=  
|gr1= High Command


|p2= |PARAMETER2=  
|gr2= Event Handlers


|p3= |PARAMETER3=
|descr= Defines an action performed when player clicked on group marker (3D or in a map). The code executed once.
This EH, unlike [[onGroupIconOverEnter]] and [[onGroupIconOverLeave]], has one more param which returns 1 if RMB was pressed, 0 otherwise.
{{Feature|arma3|Since {{arma3}} v1.58 a [[Arma 3: Mission Event Handlers#GroupIconClick|Mission Event Handler]] exists and should be used.}}


| [[Nothing]] |RETURNVALUE=
|s1= [[onGroupIconClick]] command


|x1= <code>[[onGroupIconClick]]
|p1= command: [[String]] or [[Code]] - script
 
|r1= [[Nothing]]
 
|x1= <sqf>
onGroupIconClick
{
{
    // Passed values for _this are:
// passed values for _this are:
    _is3D = _this [[select]] 0;
params ["_is3D", "_group", "_wpID", "_posX", "_posY", "_shift", "_ctrl", "_alt"];
    _group = _this [[select]] 1;
    _wpID = _this [[select]] 2;
    _RMB = _this [[select]] 3;
    _posx = _this [[select]] 4;
    _posy = _this [[select]] 5;
    _shift = _this [[select]] 6;
    _ctrl = _this [[select]] 7;
    _alt = _this [[select]] 8;
 
    _message = [[format]] ["____ Info ____"];
    {_message = _message + [[format]] ["\n %1",_x]} [[forEach]] _this;
    [[hint]] _message;
}</code>|EXAMPLE1=


____________________________________________________________________________________________
// before Arma 3
_is3D = _this select 0;
_group = _this select 1;
_wpID = _this select 2;
_RMB = _this select 3;
_posx = _this select 4;
_posy = _this select 5;
_shift = _this select 6;
_ctrl = _this select 7;
_alt = _this select 8;


| [[addGroupIcon]], [[clearGroupIcons]], [[getGroupIcon]], [[getGroupIconParams]], [[groupIconSelectable]], [[groupIconsVisible]], [[removeGroupIcon]], [[setGroupIcon]], [[setGroupIconParams]], [[setGroupIconsSelectable]], [[setGroupIconsVisible]], [[onGroupIconOverEnter]], [[onGroupIconOverLeave]] |SEEALSO=
_message = format ["____ Info ____"];
{_message = _message + format ["\n %1", _x]} forEach _this;
hint _message;
};
</sqf>


| |MPBEHAVIOUR=  
|seealso= [[addGroupIcon]] [[clearGroupIcons]] [[getGroupIcon]] [[getGroupIconParams]] [[groupIconSelectable]] [[groupIconsVisible]] [[removeGroupIcon]] [[setGroupIcon]] [[setGroupIconParams]] [[setGroupIconsSelectable]] [[setGroupIconsVisible]] [[onGroupIconOverEnter]] [[onGroupIconOverLeave]]
____________________________________________________________________________________________
}}
}}
<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:19, 13 May 2022

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 player clicked on group marker (3D or in a map). The code executed once. This EH, unlike onGroupIconOverEnter and onGroupIconOverLeave, has one more param which returns 1 if RMB was pressed, 0 otherwise.
Arma 3
Since Arma 3 v1.58 a Mission Event Handler exists and should be used.
Groups:
High CommandEvent Handlers

Syntax

Syntax:
onGroupIconClick command
Parameters:
command: String or Code - script
Return Value:
Nothing

Examples

Example 1:
onGroupIconClick { // passed values for _this are: params ["_is3D", "_group", "_wpID", "_posX", "_posY", "_shift", "_ctrl", "_alt"]; // before Arma 3 _is3D = _this select 0; _group = _this select 1; _wpID = _this select 2; _RMB = _this select 3; _posx = _this select 4; _posy = _this select 5; _shift = _this select 6; _ctrl = _this select 7; _alt = _this select 8; _message = format ["____ Info ____"]; {_message = _message + format ["\n %1", _x]} forEach _this; hint _message; };

Additional Information

See also:
addGroupIcon clearGroupIcons getGroupIcon getGroupIconParams groupIconSelectable groupIconsVisible removeGroupIcon setGroupIcon setGroupIconParams setGroupIconsSelectable setGroupIconsVisible onGroupIconOverEnter onGroupIconOverLeave

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=onGroupIconClick&oldid=321243"