Events

Reference for the events API.

Functions

events.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

events.unsubscribe

Delete a callback using the id returned from subscribe.

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

events.get

Returns an event for a given callback id.

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

Types

event

Field	Type
enabled	bool
fn	function

player_join

Field	Type
player	player
slot	integer

player_leave

Field	Type
player	player
slot	integer

player_flagged

Field	Type
player	player
reason	string

log

Field	Type
text	string
color	color
prefix	string
time	string

scroll

Field	Type
offset	number

key_press

Field	Type
key	integer

char_press

Field	Type
char	string

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

Examples

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)