events

Listener Types

TypeCallback
on_player_joinfunction(name: string, index: int, rid: int): void
on_player_leavefunction(name: stirng, index: int, rid: int): void
on_player_spawnfunction(name: string, index: int): void
on_entity_damagedfunction(victim_entity: int, damager_entity: int, weapon_hash: int, ammo_hash: int, damage: float, victim_dead: bool, was_suicide: bool): void
on_entity_revivedfunction(victim_entity: int, reviver_entity: int): void
on_script_eventfunction(...): void

Methods

has_listener

Returns true if this event type has a listener registered with the provided name

function events.has_listener(type: string, name: string): bool
-- example usage
local registered = events.has_listener("on_player_join", "Example")

add_listener

Returns true if the listener was successfully registered

function events.add_listener(type: string, name: string, callback: function): bool
-- example usage
local registered = events.add_listener("on_player_join", "Example", function(name, index, rid)
    -- do something on event
end)

remove_listener

Returns true if the listener was successfully found and removed

function events.remove_listener(type: string, name: string): bool
-- example usage
local removed = events.remove_listener("on_player_join", "Example")