Difference between revisions of "EventDispatcher:removeEventListener"

From GiderosMobile
m (Text replacement - "</source>" to "</syntaxhighlight>")
 
(8 intermediate revisions by 2 users not shown)
Line 1: Line 1:
__NOTOC__
 
 
'''Available since:''' Gideros 2011.6<br/>
 
'''Available since:''' Gideros 2011.6<br/>
 +
'''Class:''' [[EventDispatcher]]<br/>
 +
 
=== Description ===
 
=== Description ===
<translate><br />
+
Removes a listener from the [[EventDispatcher]] object.
Removes a listener from the [[Special:MyLanguage/EventDispatcher|EventDispatcher]] object. [[Special:MyLanguage/removeEventListener()|removeEventListener()]] function expects<br />
+
<syntaxhighlight lang="lua">
the same arguments with [[Special:MyLanguage/addEventListener()|addEventListener()]] to remove the event. If there is no matching listener<br />
+
EventDispatcher:removeEventListener(type,listener,data)
registered, a call to this function has no effect.<br />
+
</syntaxhighlight>
<br /></translate>
+
 
<source lang="lua">
+
'''removeEventListener()''' function expects the same arguments than the '''addEventListener()''' to remove the event.
EventDispatcher:removeEventListener(type,listener,data)
+
 
</source>
+
If there is no matching listener registered, a call to this function has no effect.
 +
 
 
=== Parameters ===
 
=== Parameters ===
'''type''': (string) <translate>The type of event.</translate> <br/>
+
'''type''': (string) the type of event<br/>
'''listener''': (function) <translate>The listener object to remove.</translate> <br/>
+
'''listener''': (function) the listener object to remove<br/>
'''data''': (any) <translate>The data parameter that is used while registering the event.</translate> <br/>
+
'''data''': (any) the data parameter that is used while registering the event<br/>
 +
 
 +
{{EventDispatcher}}

Latest revision as of 14:27, 13 July 2023

Available since: Gideros 2011.6
Class: EventDispatcher

Description

Removes a listener from the EventDispatcher object.

EventDispatcher:removeEventListener(type,listener,data)

removeEventListener() function expects the same arguments than the addEventListener() to remove the event.

If there is no matching listener registered, a call to this function has no effect.

Parameters

type: (string) the type of event
listener: (function) the listener object to remove
data: (any) the data parameter that is used while registering the event