displayRemoveEventHandler: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "(\|p[0-9]+ *= * )+" to "")
m (Text replacement - "Nelis.75733126" to "Nelis75733126")
 
(31 intermediate revisions by 5 users not shown)
Line 1: Line 1:
{{RV|type=command
{{RV|type=command


| arma2
|game1= arma2
|version1= 1.00


|1.00
|game2= arma2oa
|version2= 1.50
 
|game3= tkoh
|version3= 1.00
 
|game4= arma3
|version4= 0.50


|gr1= GUI Control - Event Handlers
|gr1= GUI Control - Event Handlers
|gr2= Event Handlers
|gr2= Event Handlers


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


| display '''displayRemoveEventHandler''' [handler name,id]
|s1= display [[displayRemoveEventHandler]] [handlerType, id]


|p1= display: [[Display]]
|p1= display: [[Display]]


|p2= [handler name,id]: [[Array]]
|p2= handlerType: [[String]] - type of the event handler
 
|p3= id: [[Number]] - index of the event handler


| Nothing
|r1= [[Nothing]]


|x1= <code>[[findDisplay]] 46 [[displayRemoveEventHandler]] ["keyDown",5];</code>
|x1= <sqf>findDisplay 46 displayRemoveEventHandler ["keyDown",5];</sqf>


| [[disableSerialization]], [[Display]], [[displayAddEventHandler]], [[displayRemoveAllEventHandlers]]
|seealso= [[disableSerialization]] [[Display]] [[displayAddEventHandler]] [[displayRemoveAllEventHandlers]]
}}
}}


<dl class="command_description">


{{GameCategory|arma2|Scripting Commands}}
<dt></dt>
{{GameCategory|arma3|Scripting Commands}}
<dd class="notedate">Posted on 2015-04-19 - 21:25 (UTC)</dd>
{{GameCategory|tkoh|Scripting Commands}}
<dt class="note">[[User:Nelis75733126|Nelis75733126]]</dt>
[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]
 
<!-- CONTINUE Notes -->
<dl class="command_description">
<dd class="notedate">Posted on April 19, 2015 - 21:25 (UTC)</dd>
<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 15:38, 29 June 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)
Nelis75733126
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 )