Skip to content

events


Listener Types

Type Arguments
on_player_join string name, int index, int rid
on_player_leave string name, int index, int rid
on_player_spawn string name, int index
on_entity_damaged int victim_entity, int damager_entity, int weapon_hash, int ammo_hash, float damage, bool victim_dead, bool was_suicide
on_entity_revived int victim_entity, int reviver_entity
on_script_event ...

has_listener

bool events.has_listener(string type, string name)

Returns true if this event type has a listener registered with the provided name
Example Usage
local registered = events.has_listener("on_player_join", "Example")

add_listener

bool events.add_listener(string type, string name, function callback)

Returns true if the listener was successfully registered
Example Usage
local registered = events.add_listener("on_player_join", "Example", function(name, index, rid)
    -- do something on event
end)

remove_listener

bool events.remove_listener(string type, string name)

Returns true if the listener was successfully found and removed
Example Usage
local removed = events.remove_listener("on_player_join", "Example")