Modules
Callback
Client

Client

Callbacks enable communication between client and server with synchronous-style syntax.

lib.callback.register

Register a callback that the server can await for.

lib.callback.register(name, func)

Parameters

  • name: string
  • func: function

Returns

  • success: boolean

Examples

  • Lua
client.lua
lib.callback.register('createMultiplePeds', function(peds, defaultSettings)
  local createdPeds<const> = createMultiplePeds(peds, defaultSettings)
  return createdPeds
end)
  • JavaScript
client.js
lib.callback.register('createMultiplePeds', function(peds, defaultSettings) {
  const createdPeds = createMultiplePeds(peds, defaultSettings)
  return createdPeds
})

lib.callback.await

Await for a registered server callback's result.

lib.callback.await(debug, name, timeout, ...)

Parameters

  • debug: boolean (optional)
  • name: string
  • timeout: number | nil
  • ... : varargs

Returns

  • any

Examples

  • Lua
client.lua
lib.callback.register('createSinglePed', function(settings)
  local fallback<const> = lib.callback.await('getDefaultSettings', nil, settings)
  local createdPeds<const> = createSinglePed(settings, fallback)
  return createdPeds
end)
  • JavaScript
client.js
lib.callback.register('createSinglePed', function(settings) {
  const fallback = await lib.callback.await('getDefaultSettings', nil, settings)
  const createdPeds = createSinglePed(settings, fallback)
  return createdPeds
})