Function

A remote function. Constructed with Function.

Remote functions are only Client -> Server -> Client, never vice versa. This is to prevent many issues, including infinitely yielding the server.

server

local GetMoney = Riptide.Function(
    "GetMoney",
    function() end,
    function(Money)
        return Riptide.Guard.Number(Money) -- Types the return as a Number
    end
)

GetMoney:Ratelimit(1, 1) -- Ratelimits the function to 1 call per second

GetMoney:SetCallback(function(Player)
    return Data:GetMoney(Player)
end)

client

local GetMoney = Riptide.Function(
    "GetMoney",
    function() end,
    function(Money)
        return Riptide.Guard.Number(Money) -- Types the return as a Number
    end
)

local Money = GetMoney:Call():Await()

Methods

SetCallback

Function.SetCallback<T..., U...>(
    self: Function<T..., U...>,
    Callback: (
        Player,
        Args
    ) → U...
) → ()

Sets the callback of the remote function.

WARNING

Only callable on the server!

Call

Function.Call<T..., U...>(
    self: Function<T...,U...>,
    ...: T... -- Args
) → ()

Calls the remote function.

WARNING

Only callable on the client!

Ratelimit

Function.Ratelimit<T..., U...>(
    self: Function<T...,U...>,
    Limit: number,
    Interval: number
) → ()

Ratelimits the function.