Difference between revisions of "displayRemoveEventHandler"

From Bohemia Interactive Community
Jump to navigation Jump to search
m (fixed example (Command returns nothing) and formatted note)
m
 
(32 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
  
| 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>[[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= <code>[[findDisplay]] 46 [[displayRemoveEventHandler]] ["keyDown",5];</code>
____________________________________________________________________________________________
+
 
 +
|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 April 19, 2015 - 21:25 (UTC)</dd>
 
<dd class="notedate">Posted on April 19, 2015 - 21:25 (UTC)</dd>
 
<dt class="note">[[User:IT07|IT07]]</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>
+
<code>_myEH = [[findDisplay]] 46 [[displayAddEventHandler]] ["KeyDown", "[[hint]] [[str]] [[Magic Variables#this|_this]]"];</code>
 
Then this would be the correct code to remove that eventHandler again:
 
Then this would be the correct code to remove that eventHandler again:
 
<code>[[findDisplay]] 46 [[displayRemoveEventHandler]] ["KeyDown", _myEH];</code>
 
<code>[[findDisplay]] 46 [[displayRemoveEventHandler]] ["KeyDown", _myEH];</code>
 
</dd>
 
</dd>
 +
 
</dl>
 
</dl>
<!-- DISCONTINUE Notes -->
 

Latest revision as of 12:07, 9 October 2021

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:
disableSerializationDisplaydisplayAddEventHandlerdisplayRemoveAllEventHandlers

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 April 19, 2015 - 21:25 (UTC)
IT07
If you for example used this code to add the eventHandler: _myEH = findDisplay 46 displayAddEventHandler ["KeyDown", "hint str _this"]; Then this would be the correct code to remove that eventHandler again: findDisplay 46 displayRemoveEventHandler ["KeyDown", _myEH];