UgCore.Callback

Shared Runs in your resource. No export hop per call. See the Callbacks guide.

Server

Register

UgCore.Callback.Register(name, options, handler)

string

required

Letters, digits and underscores. Registered as <resource>:<name>.

UgNetworkOptions

required

Show fields

UgSchema

required

From UgCore.Schema.Define.

{ max, per }

required

Per player, in ms.

boolean

Rejects players whose ug-core:Loaded statebag is not true.

boolean

Rejects downed and dead players with no_permission.

string

ACE the player MUST have.

fun(source, ...): any

required

Gets validated arguments. Returns one value.

Pipeline, in order: exists, concurrency cap (4 in flight per player), global budget and rate limit, requirePlayer, requireAlive, permission, schema, handler, reply. A handler error replies internal_error and logs on the server.

Unregister

UgCore.Callback.Unregister(name) -> removed

Await

UgCore.Callback.Await(source, fullName, { schema, timeout? }, ...) -> ok, value, errorCode

Asks a client. MUST run in a thread. The reply is untrusted, so it is validated with schema, a single rule from UgCore.Schema. timeout defaults to 10000 ms.

Trigger

UgCore.Callback.Trigger(source, fullName, options, cb, ...)

Callback form of Await. cb gets (ok, value, errorCode).

Client

Await

UgCore.Callback.Await(fullName, ...) -> ok, value, errorCode

MUST run in a thread. Times out after 10 seconds with timeout. Late responses are ignored.

Trigger

UgCore.Callback.Trigger(fullName, cb, ...)

Register / Unregister

UgCore.Callback.Register(name, handler)
UgCore.Callback.Unregister(name) -> removed

Answers server requests to <resource>:<name>. The handler returns one value.

Example

local S = UgCore.Schema

UgCore.Callback.Register('GetPrice', {
    schema = S.Define({ S.String({ max = 32 }) }),
    rate = { max = 5, per = 1000 },
    requirePlayer = true,
}, function(source, item)
    return PRICES[item]
end)

CreateThread(function()
    local ok, price, err = UgCore.Callback.Await('my-shop:GetPrice', 'water')

    if ok then
        print(('Water costs $%d'):format(price))
    end
end)

Overview

Core

Networking and security

Modules

Reference

UgCore.Callback

Server

Register

Unregister

Await

Trigger

Client

Await

Trigger

Register / Unregister

Example

​Server

​Register

​Unregister

​Await

​Trigger

​Client

​Await

​Trigger

​Register / Unregister

​Example

Server

Register

Unregister

Await

Trigger

Client

Await

Trigger

Register / Unregister

Example