Events

Functions

subscribe

Register a callback to be fired when the event is handled, returning a callback id.

---@param type events.event
---@param callback function(data)
function events.subscribe(type, callback): integer

unsubscribe

Delete a callback using the id returned from subscribe.

---@param id integer
function events.subscribe(id): nil

get

Returns an event for a given callback id.

---@param id integer
function events.get(id) -> event

Types

event

player_join

player_leave

player_flagged

log

scroll

key_press

char_press

Constants

event

events.event.player_join
events.event.player_leave
events.event.player_flagged
events.event.log
events.event.scroll
events.event.key_press
events.event.char_press

Example

events.subscribe(events.event.key_press, function(data)
  print('key pressed: ' .. tostring(data.key))
end)

events.subscribe(events.event.char_press, function(data)
  print('char pressed: ' .. data.char)
end)

events.subscribe(events.event.scroll, function(data)
  print('scroll: ' .. tostring(data.offset))
end)