displayRemoveEventHandler: 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")
No edit summary
 
(51 intermediate revisions by 4 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


| Remove a given event handler from the given display. |DESCRIPTION=
|game3= tkoh
____________________________________________________________________________________________
|version3= 1.00


| display '''displayRemoveEventHandler''' [handler name,id] |SYNTAX=
|game4= arma3
|version4= 0.50


|p1= display: [[Display]] |PARAMETER1=  
|gr1= GUI Control - Event Handlers


|p2= [handler name,id]: [[Array]] |PARAMETER2=  
|gr2= Event Handlers


|p3= |PARAMETER3=  
|descr= Remove a given event handler from the given display.


| Nothing |RETURNVALUE=  
|s1= display [[displayRemoveEventHandler]]  [handlerType, id]


|p1= display: [[Display]]


|x1= <code>moduleName_keyDownEHId <nowiki>=</nowiki> ([[findDisplay]] 46) [[displayRemoveEventHandler]] ["keyDown",5];</code>|EXAMPLE1=
|p2= handlerType: [[String]] - type of the event handler


____________________________________________________________________________________________
|p3= id: [[Number]] - index of the event handler


| [[disableSerialization]], [[Display]], [[displayAddEventHandler]], [[displayRemoveAllEventHandlers]] |SEEALSO=
|r1= [[Nothing]]


| |MPBEHAVIOUR=  
|x1= <sqf>findDisplay 46 displayRemoveEventHandler ["keyDown",5];</sqf>
____________________________________________________________________________________________
 
|seealso= [[disableSerialization]] [[Display]] [[displayAddEventHandler]] [[displayRemoveAllEventHandlers]]
}}
}}


<h3 style='display:none'>Notes</h3>
<dl class="command_description">
<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}}}}]]
[[Category:Command_Group:_GUI_Control|{{uc:{{PAGENAME}}}}]]


<!-- CONTINUE Notes -->
<dt></dt>
<dl class="command_description">
<dd class="notedate">Posted on 2015-04-19 - 21:25 (UTC)</dd>
<dd class="notedate">Posted on April 19, 2015 - 21:25 (UTC)</dd>
<dt class="note">[[User:Nelis.75733126|Nelis.75733126]]</dt>
<dt class="note">[[User:IT07|IT07]]</dt>
<dd class="note">
<dd class="note">
If you for example used this code to add the eventHandler:
If you for example used this code to add the eventHandler:
<code>_myEH = (findDisplay 46) displayAddEventHandler ["KeyDown", "hint str _this"];</code>
<sqf>_myEH = findDisplay 46 displayAddEventHandler ["KeyDown", "hint str _this"];</sqf>
Then this would be the correct code to remove that eventHandler again:
Then later in that same script you can use the <sqf inline>_myEH</sqf> private variable to remove that same eventHandler again:
<code>(findDisplay 46) displayRemoveEventHandler ["KeyDown", _myEH];</code>
<sqf>findDisplay 46 displayRemoveEventHandler ["KeyDown", _myEH];</sqf>
( if obviously that private variable is known to the script environment you are referencing <sqf inline>_myEH</sqf> in )
</dd>
</dd>
</dl>
</dl>
<!-- DISCONTINUE Notes -->

Latest revision as of 20:04, 16 April 2024

Hover & click on the images for description

Description

Description:
Remove a given event handler from the given display.
Groups:
GUI Control - Event HandlersEvent Handlers

Syntax

Syntax:
display displayRemoveEventHandler [handlerType, id]
Parameters:
display: Display
handlerType: String - type of the event handler
id: Number - index of the event handler
Return Value:
Nothing

Examples

Example 1:
findDisplay 46 displayRemoveEventHandler ["keyDown",5];

Additional Information

See also:
disableSerialization Display displayAddEventHandler displayRemoveAllEventHandlers

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
Posted on 2015-04-19 - 21:25 (UTC)
Nelis.75733126
If you for example used this code to add the eventHandler:
_myEH = findDisplay 46 displayAddEventHandler ["KeyDown", "hint str _this"];
Then later in that same script you can use the _myEH private variable to remove that same eventHandler again:
findDisplay 46 displayRemoveEventHandler ["KeyDown", _myEH];
( if obviously that private variable is known to the script environment you are referencing _myEH in )