Difference between revisions of "EventDispatcher:removeEventListener"
From GiderosMobile
(----) |
m (Text replacement - "</source>" to "</syntaxhighlight>") |
||
| (3 intermediate revisions by 2 users not shown) | |||
| Line 4: | Line 4: | ||
=== Description === | === Description === | ||
Removes a listener from the [[EventDispatcher]] object. | Removes a listener from the [[EventDispatcher]] object. | ||
| − | < | + | <syntaxhighlight lang="lua"> |
| + | EventDispatcher:removeEventListener(type,listener,data) | ||
| + | </syntaxhighlight> | ||
| − | ''removeEventListener()'' function expects the same arguments than the ''addEventListener()'' to remove the event | + | '''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 === | === Parameters === | ||
| − | '''type''': (string) | + | '''type''': (string) the type of event<br/> |
| − | '''listener''': (function) | + | '''listener''': (function) the listener object to remove<br/> |
| − | '''data''': (any) | + | '''data''': (any) the data parameter that is used while registering the event<br/> |
| − | |||
| − | |||
| − | |||
| − | <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
