Module client
Client -> server callbacks
Functions
| triggerServerCallback (callbackName, cb, ...) | Execute a server callback asynchronously |
| deferServerCallback (callbackName, ...) | Create a promise for a server callback |
| awaitServerCallback (callbackName, ...) | Execute a server callback synchronously |
| registerClientCallback (callbackName, fn) | Register a new client callback |
| removeClientCallback (callbackName) | Remove a registered client callback |
Functions
- triggerServerCallback (callbackName, cb, ...)
-
Execute a server callback asynchronously
Parameters:
- callbackName The name of the server callback
- cb A callback function to execute when the server callback completes
- ... Additional parameters passed to the server callback
Usage:
exports.callbacks:triggerServerCallback("getNumPlayers", function(numPlayers) print(numPlayers) end)
- deferServerCallback (callbackName, ...)
-
Create a promise for a server callback
Parameters:
- callbackName The name of the server callback
- ... Additional parameters passed to the server callback
Returns:
-
A new promise that will be resolved when the server callback completes. If the callback returns multiple values, they will be wrapped in a table.
Usage:
exports.callbacks:deferServerCallback("getNumPlayers"):next(function(numPlayers) print(numPlayers) end)
- awaitServerCallback (callbackName, ...)
-
Execute a server callback synchronously
Parameters:
- callbackName The name of the server callback
- ... Additional parameters passed to the server callback
Returns:
-
Any value(s) returned by the server callback
Usage:
local numPlayers = exports.callbacks:awaitServerCallback("getNumPlayers")
- registerClientCallback (callbackName, fn)
-
Register a new client callback
Parameters:
- callbackName The name of the new client callback
- fn The function to execute when this client callback is executed
Usage:
exports.callbacks:registerClientCallback("getCoords", function() return GetEntityCoords(PlayerPedId()) end)
- removeClientCallback (callbackName)
-
Remove a registered client callback
Parameters:
- callbackName The name of the registered client callback
Usage:
exports.callbacks:removeClientCallback("getCoords")