Skip to content

events.md

Latest commit

 

History

History
50 lines (38 loc) · 1.26 KB

events.md

File metadata and controls

50 lines (38 loc) · 1.26 KB

Events

A collection of listeners for specific events. Available for App.events and Sprite.events.

With this property you can associate (or disassociate) a function to a specific event.

Events:on()

local listenerCode = events:on(eventName, function)

Connects the given function (2nd argument) with the given event by eventName (a string, the event name/code/identifier). When the event happens in the future the function will be called automatically. This is like the function starts "listening" the event.

The returned listenerCode is a numeric value that indicates the connection between the event and the function. You can use this value in Events.off() to stop listening/break the connection with the event.

E.g.

app.events:on('sitechange',
  function()
    print('app.site has changed')
  end)

Events:off()

events:off(function)
events:off(listenerCode)

Disconnects the given function from all events in the object, or stops/breaks only the specific connection identified by listenerCode (the code returned by Events:on()).

local function onSiteChange() ... end
app.events:on('sitechange', onSiteChange)
app.events:off(onSiteChange)