FiveM RPC

Exports

Register and trigger events, create RPC listeners and call them between server, client and browser environments.

Server and client

API reference

Adding events

Register individual or grouped local and global events.

4 exports

NameDescriptionParametersReturns

exports["fivem-rpc"]:on(eventName, cb)

Adds a single local event.

eventNamestringcbEventCallback

—

exports["fivem-rpc"]:onGlobal(eventName, cb)

Adds a single global event.

eventNamestringcbEventCallback

—

exports["fivem-rpc"]:onMany(e)

Adds multiple local events from a key-value table.

eRecord<string, EventCallback>

—

exports["fivem-rpc"]:onGlobalMany(e)

Adds multiple global events from a key-value table.

eRecord<string, EventCallback>

—

Examples

on

Configuration

on

Local event example.

exports['fivem-rpc']:on('onPlayerLogin', function(playerSource)
    print(playerSource)
end)

onGlobal

Configuration

onGlobal

Global event example.

exports['fivem-rpc']:onGlobal('onPlayerLogin', function(playerSource)
    print(playerSource)
end)

onMany

Configuration

onMany

Multiple local events example.

exports['fivem-rpc']:onMany({
    ['onPlayerLogin'] = function(playerSource)
        print(playerSource)
    end,
    ['onPlayerLogout'] = function(playerSource)
        print(playerSource)
    end
})

onGlobalMany

Configuration

onGlobalMany

Multiple global events example.

exports['fivem-rpc']:onGlobalMany({
    ['onPlayerLogin'] = function(playerSource)
        print(playerSource)
    end,
    ['onPlayerLogout'] = function(playerSource)
        print(playerSource)
    end
})

API reference

Triggering events

Trigger a local or global event with optional arguments.

2 exports

NameDescriptionParametersReturns

exports["fivem-rpc"]:trigger(eventName, args?)

Triggers a local event.

eventNamestringargs?any

—

exports["fivem-rpc"]:triggerGlobal(eventName, args?)

Triggers a global event.

eventNamestringargs?any

—

Examples

trigger

Configuration

trigger

Local event trigger example.

exports["fivem-rpc"]:trigger("onPlayerLogin", 2)

triggerGlobal

Configuration

triggerGlobal

Global event trigger example.

exports["fivem-rpc"]:triggerGlobal("onPlayerLogin", 2)

API reference

Creating listeners

Register local or global RPC listeners.

2 exports

NameDescriptionParametersReturns

exports["fivem-rpc"]:register(eventName, cb)

Registers a local RPC listener.

eventNamestringcbRemoteCallback

—

exports["fivem-rpc"]:registerGlobal(eventName, cb)

Registers a global RPC listener.

eventNamestringcbRemoteCallback

—

Examples

register

Configuration

Register the listener

Register the listener on the client.

Register a client-side listener

exports["fivem-rpc"]:register("isPlayerSwimming", function()
    return IsPedSwimming(PlayerPedId())
end)

Configuration

Call the listener

Call the event from the server.

Calling the event from server

local isSwimming = exports["fivem-rpc"]:callClient(source, "isPlayerSwimming")
print(isSwimming)

registerGlobal

Configuration

Register the global listener

Register the listener on the client.

Register a client-side listener

exports["fivem-rpc"]:registerGlobal("isPlayerSwimming", function()
    return IsPedSwimming(PlayerPedId())
end)

Configuration

Call the global listener

Call the event from the server.

Calling the event from server

local isSwimming = exports["fivem-rpc"]:callGlobalClient(source, "isPlayerSwimming")
print(isSwimming)

API reference

Calling listeners

Call registered listeners from the server, client or either shared environment.

6 exports

NameDescriptionParametersReturns

callClient(source, eventName, args)

Server only.

source—eventName—args—

—

callGlobalClient(source, eventName, args)

Server only.

source—eventName—args—

—

callServer(eventName, args)

Client only.

eventName—args—

—

callGlobalServer(eventName, args)

Client only.

eventName—args—

—

call(eventName, args)

Shared.

eventName—args—

—

callGlobal(eventName, args)

Shared.

eventName—args—

—

Browser / NUI / CEF

Import the browser.js or browser.ts file into your frontend.

Configuration

Browser RPC functions

Global event and listener functions available in the browser environment.

- triggerGlobalServer(eventName: string, args?: any)
- triggerGlobalClient(eventName: string, args?: any)
- callGlobalServer<T>(eventName: string, args?:any): Promise<T>
- callGlobalClient<T>(eventName: string, args?:any): Promise<T>