Communicating with Events#

This page shows how to use the global event system to send structured data between the client and server in your game. Events can include a wide range of arguments like strings, numbers, booleans, nil, vectors, and tables. Both sides of the network can register handlers and trigger events using the TriggerServerEvent and TriggerClientEvent functions on the player controller.

Tip

The triggering controller is passed automatically as the first parameter when a client triggers a server event — similar to how source is passed in FiveM

Registering Client Events#

Use RegisterClientEvent(name, callback) to listen for events on the client-side. These handlers will be called when the server triggers an event targeted to the client

Example

RegisterClientEvent('TestClient', function(str, num, bool, nil_val, vec, tbl)
    print('--------------------------------------------')
    print('CLIENT TestClient EVENT')
    print('  String:', str, 'Type:', type(str))
    print('  Number:', num, 'Type:', type(num))
    print('  Boolean:', bool, 'Type:', type(bool))
    print('  Nil:', nil_val, 'Type:', type(nil_val))
    print('  Vector:', vec, 'Type:', type(vec))
    print('  Table:', tbl, 'Type:', type(tbl))
    print('--------------------------------------------')
end)

Registering Server Events#

Use RegisterServerEvent(name, callback) to listen for events on the server-side. These handlers receive the triggering player controller as the first argument, followed by the arguments sent from the client

Example

RegisterServerEvent('TestServer', function(controller, str, num, bool, nil_val, vec, tbl)
    print('--------------------------------------------')
    print('SERVER TestServer EVENT from', controller)
    print('  String:', str, 'Type:', type(str))
    print('  Number:', num, 'Type:', type(num))
    print('  Boolean:', bool, 'Type:', type(bool))
    print('  Nil:', nil_val, 'Type:', type(nil_val))
    print('  Vector:', vec, 'Type:', type(vec))
    print('  Table:', tbl, 'Type:', type(tbl))
    print('--------------------------------------------')

    TriggerClientEvent(controller, 'TestClient', str, num, bool, nil_val, vec, tbl)
end)

Triggering Client Events#

Use TriggerClientEvent(controller, name, ...) from the server to send a message to a specific client. All extra arguments are automatically serialized and passed into the client handler. This method works for server -> client

Example

-- Inside a server context
TriggerClientEvent(controller, 'TestClient', "Hello from Server", 100, true, nil, Vector(100, 100, 100), { value = 42 })

Triggering Local Client Events#

Use TriggerLocalClientEvent(name, ...) from the client to send a message to another lua package, contained to the same client it's called from. All extra arguments are automatically serialized and passed into the client handler. This method works for client -> client

Example

-- Inside a client context
TriggerLocalClientEvent('TestClient', "Hello from Server", 100, true, nil, Vector(100, 100, 100), { value = 42 })

Triggering Server Events#

Use TriggerServerEvent(name, ...) from the client to send a message to the server. All arguments will be received by the registered server handler with the triggering controller passed in automatically. This method works for client -> server

Example

-- Inside a client context
TriggerServerEvent('TestServer', 'Hello from Client', 100, true, nil, Vector(100, 100, 100), { key = 'value' })

Triggering Local Server Events#

Use TriggerLocalServerEvent(name, ...) from the server to send a message to the server allowing for cross-package communication without relying on the client. All arguments will be received by the registered server handler. This method works for server -> server

Example

-- Inside a server context
TriggerLocalServerEvent('TestServer', 'Hello from Client', 100, true, nil, Vector(100, 100, 100), { key = 'value' })