Lua · Variables · Helpers

events

Subscribe to game events with any number of handlers.

See Callbacks and events for every event and its fields.

FunctionWhat it does
events.on(name, handler)Adds a handler. Several handlers for one event all run, in the order added.
events.off(name)Removes all handlers of that event.

#events.on

events.on(name, handler)

Adds a handler. Several handlers for one event all run, in the order added.

Arguments

namestring
Event name, for example player_hurt.
handlerfunction(e)
Gets the event table.
Example
events.on("bomb_planted", function(e) notify.push("Planted " .. e.site) end)

#events.off

events.off(name)

Removes all handlers of that event.