it-s / lua-Events

A simple LUA class that adds ability to send and receive events to any LUA table object.

lua-Events

A simple LUA class that adds ability to send and receive events to any LUA table object.

##Adding you your [existing] project

• Add the library to your git project. Clone it, or use it as a submodule:

  git submodule add [e-mail]:it-s/lua-Events.git

##Initializing the module

• Include it into your project: local luaEvents = require "lua-Events.Events"
• Apply the events management system to an existing LUA object:

  local object = {
    property = "",
    ...
  }
  object = luaEvents.extend(object)

or provide no argumats and Events module will return an empty, event enabled object:

  local object = luaEvents.extend()

or use the power of LUA and create your object on the fly:

  local object = luaEvents.extend({
    property = "",
    ...
  })

##Using the event manager ###Creating an event listener

  object:addEventListener(identifierString, functionToExecute)

• identifierString - name of en event to watch for as String
• functionToExecute - a function to execute when event is called

  function fn(eventName, params){
    print (eventName)
    -- params can be anything you wish
    -- they get passed to the listeneer by the dispatchEvent function
  }

###Dispatching an event

  object:dispatchEvent(identifierString, params)

• identifierString - name of en event to fire
• params - a table object containing arbitrary params that will be passed along to the listener function

  object:dispatchEvent('eventName', 
  {
    -- this element is required
    someData = ...
  })

###Removing an event listener

  object:removeEventListener(identifierString, functionToExecute)

• identifierString - name of en event to watch for as String
• functionToExecute - a function to execute that you wish to remove from stack ###Remove all event listeners of type

  object:removeEventListeners(identifierString)

• identifierString - name of en event to watch for as String ###Remove all event listeners

  object:removeEventListeners()