Skip to main content

ServerFunction

Functions​

new​

</>
ServerFunction.new(instance: RemoteEvent) → ServerFunction

SetCallback​

</>
ServerFunction:SetCallback(
expects: {TypeCheckFunc},--

What is expected from the client

callback: (
player: Player,
...any
) → ()
) → Connection

Sets the callback for the event.

AddMiddleware​

since v1.1.0
</>
ServerFunction:AddMiddleware(fn: MiddlewareFn) → ()

Adds a new middleware function to run when the function is fired

Predict​

</>
ServerFunction:Predict(
Player: player,
...: any
) → ()

Fire a function from the server to the server as a player.

Show raw api
{
    "functions": [
        {
            "name": "new",
            "desc": "",
            "params": [
                {
                    "name": "instance",
                    "desc": "",
                    "lua_type": "RemoteEvent"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "ServerFunction"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 191,
                "path": "Source/Networking/Classes/Server.luau"
            }
        },
        {
            "name": "SetCallback",
            "desc": "Sets the callback for the event.",
            "params": [
                {
                    "name": "expects",
                    "desc": "What is expected from the client",
                    "lua_type": "{TypeCheckFunc}"
                },
                {
                    "name": "callback",
                    "desc": "",
                    "lua_type": "(player: Player, ...any) -> ()"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Connection"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 208,
                "path": "Source/Networking/Classes/Server.luau"
            }
        },
        {
            "name": "AddMiddleware",
            "desc": "Adds a new middleware function to run when the function is fired",
            "params": [
                {
                    "name": "fn",
                    "desc": "",
                    "lua_type": "MiddlewareFn"
                }
            ],
            "returns": [],
            "function_type": "method",
            "since": "v1.1.0",
            "source": {
                "line": 268,
                "path": "Source/Networking/Classes/Server.luau"
            }
        },
        {
            "name": "Predict",
            "desc": "Fire a function from the server to the server as a player.",
            "params": [
                {
                    "name": "Player",
                    "desc": "",
                    "lua_type": "player"
                },
                {
                    "name": "...",
                    "desc": "",
                    "lua_type": "any"
                }
            ],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 280,
                "path": "Source/Networking/Classes/Server.luau"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "ServerFunction",
    "desc": "",
    "source": {
        "line": 165,
        "path": "Source/Networking/Classes/Server.luau"
    }
}