Module flower.EventDispatcher

This class is responsible for event notifications.

Info:

  • Release: V3.0.0
  • Author: Makoto

Functions

EventDispatcher:init () The constructor.
EventDispatcher:addEventListener (eventType, callback, source, priority) Adds an event listener.
EventDispatcher:removeEventListener (eventType, callback, source) Removes an event listener.
EventDispatcher:setEventListener (eventType, callback, source, priority) Set the event listener.
EventDispatcher:hasEventListener (eventType, callback, source) Returns true if you have an event listener.
EventDispatcher:dispatchEvent (event, data) Dispatches the event.
EventDispatcher:clearEventListeners () Remove all event listeners.


Functions

EventDispatcher:init ()
The constructor.
EventDispatcher:addEventListener (eventType, callback, source, priority)
Adds an event listener. will now catch the events that are sent in the dispatchEvent.

Parameters:

  • eventType Target event type.
  • callback The callback function.
  • source (option)The first argument passed to the callback function.
  • priority (option)Notification order.
EventDispatcher:removeEventListener (eventType, callback, source)
Removes an event listener.

Parameters:

  • eventType Type of event to be deleted
  • callback Callback function of event to be deleted
  • source (option)Source of event to be deleted

Returns:

    True if it can be removed
EventDispatcher:setEventListener (eventType, callback, source, priority)
Set the event listener. Event listener that you set in this function is one.

Parameters:

  • eventType event type
  • callback event listener
  • source (option)event source
  • priority (option)event priority
EventDispatcher:hasEventListener (eventType, callback, source)
Returns true if you have an event listener.

Parameters:

  • eventType
  • callback
  • source

Returns:

    Returns true if you have an event listener matching the criteria.
EventDispatcher:dispatchEvent (event, data)
Dispatches the event.

Parameters:

  • event Event object or Event type name.
  • data Data that is set in the event.
EventDispatcher:clearEventListeners ()
Remove all event listeners.
generated by LDoc 1.3