Events

en-core announces almost everything it does through events, so your resources can react without polling. This page lists them all in one place. The pages for each system explain when and why they fire.

Naming:

• encore:server:* events fire on the server. Listen with AddEventHandler.
• encore:client:* net events come from the server. Listen with RegisterNetEvent.
• Some encore:client:* events are local: en-core re-fires them on the client for convenience. Listen with AddEventHandler.

#Server events

Fired by en-core on the server.

Notes:

• For radiation, infection and immunity, value is the resulting stat, not the amount changed. action is 'add', 'remove' or 'set' (immunity has no 'set').
• The per-stat survival events fire only from explicit calls such as AddRadiation. The survival tick fires onSurvivalTick and onSetMetaData instead.
• Player-object events can also fire when you change an offline player object. Don't rely on source being a valid online player in that case.

#Net events clients may send

en-core accepts these from clients. The server always uses the event's real source, never a player id from the payload.

#Client net events

Sent by the server. Register them with RegisterNetEvent.

#Client local events

Re-fired by en-core on the client. Listen with AddEventHandler.

#Callbacks

en-core registers these with the library's callback system. See Callbacks for how to call them.

#Examples

A HUD that reacts to login, stat changes and money:

-- client
AddEventHandler('encore:client:playerLoaded', function(data)
    -- build the HUD from data.metadata and data.money
end)

RegisterNetEvent('encore:client:onSetMetaData', function(key, value)
    if key == 'radiation' then
        -- update the radiation gauge
    end
end)

AddEventHandler('encore:client:moneyChanged', function(moneyType, balance, action)
    -- update the cash or bank display
end)

Server-side setup when a character loads and cleanup when they leave:

AddEventHandler('encore:server:onPlayerLoaded', function(source, playerData)
    print(('%s loaded as %s'):format(GetPlayerName(source), playerData.name))
end)

AddEventHandler('encore:server:onPlayerUnload', function(source, playerData)
    -- clear anything you cached for this source
end)

Watch every survival tick:

AddEventHandler('encore:server:onSurvivalTick', function(source, stats, damage, causes)
    if damage > 0 then
        print(source, damage, table.concat(causes, ', '))
    end
end)

#Related

• Player API
• Callbacks
• Writing a resource