Skip to main content

RemoteFunction

This item is only intended to be used by the module's authors. Private

Remote function wrapper adding additional functionality and compatibility with Cradle

warning

This is used internally by Cradle, and is not recommended to be used by the user.

Functions​

AddMiddleware​

This item only works when running on the server. Server
</>
RemoteFunction:AddMiddleware(
priority: number,
func: function
) → nil

Adds a middleware function to the RemoteFunction. This function will be called before the OnServerInvoke function, and can be used to modify the arguments passed to the OnServerInvoke function, or to modify the return value of the OnServerInvoke function.

Show raw api
{
    "functions": [
        {
            "name": "new",
            "desc": "Creates a new RemoteFunction instance, this is used to replicate values across the server and client.\n\n:::warning\nThis is used internally by Cradle, and is not recommended to be used by the user.\n:::\n\t",
            "params": [
                {
                    "name": "initialValue",
                    "desc": "",
                    "lua_type": "string | number | boolean | Instance | table"
                },
                {
                    "name": "parent",
                    "desc": "",
                    "lua_type": "Instance"
                },
                {
                    "name": "objTypeOverride",
                    "desc": "",
                    "lua_type": "string"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "RemoteFunction"
                }
            ],
            "function_type": "static",
            "realm": [
                "Server"
            ],
            "private": true,
            "source": {
                "line": 59,
                "path": "src/Util/RemoteComm/_RemoteFunction.lua"
            }
        },
        {
            "name": "AddMiddleware",
            "desc": "Adds a middleware function to the RemoteFunction. This function will be called before the OnServerInvoke function, and can be used to modify the arguments passed to the OnServerInvoke function, or to modify the return value of the OnServerInvoke function.\n\t",
            "params": [
                {
                    "name": "priority",
                    "desc": "",
                    "lua_type": "number"
                },
                {
                    "name": "func",
                    "desc": "",
                    "lua_type": "function"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "nil"
                }
            ],
            "function_type": "method",
            "realm": [
                "Server"
            ],
            "source": {
                "line": 82,
                "path": "src/Util/RemoteComm/_RemoteFunction.lua"
            }
        },
        {
            "name": "_Invoke",
            "desc": "Invokes the OnServerInvoke function, and passes the arguments through any middleware functions.\n\n:::warning\nThis is used internally by Cradle, and is not recommended to be used by the user.\n:::\n\t",
            "params": [
                {
                    "name": "...",
                    "desc": "",
                    "lua_type": "any"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "any"
                }
            ],
            "function_type": "method",
            "realm": [
                "Server"
            ],
            "private": true,
            "source": {
                "line": 100,
                "path": "src/Util/RemoteComm/_RemoteFunction.lua"
            }
        },
        {
            "name": "new",
            "desc": "Connects to an existing RemoteFunction instance, this is used to replicate values across the server and client.\n\n:::warning\nThis is used internally by Cradle, and is not recommended to be used by the user.\n:::\n\t",
            "params": [
                {
                    "name": "inst",
                    "desc": "",
                    "lua_type": "Instance"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "RemoteFunction"
                }
            ],
            "function_type": "static",
            "realm": [
                "Client"
            ],
            "private": true,
            "ignore": true,
            "source": {
                "line": 124,
                "path": "src/Util/RemoteComm/_RemoteFunction.lua"
            }
        },
        {
            "name": "InvokeServer",
            "desc": "Invokes the OnServerInvoke function, and passes the arguments through any middleware functions.\n\n:::warning\nThis is used internally by Cradle, and is not recommended to be used by the user.\n:::\n\t",
            "params": [
                {
                    "name": "...",
                    "desc": "",
                    "lua_type": "any"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "any"
                }
            ],
            "function_type": "method",
            "realm": [
                "Client"
            ],
            "private": true,
            "source": {
                "line": 146,
                "path": "src/Util/RemoteComm/_RemoteFunction.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "RemoteFunction",
    "desc": "Remote function wrapper adding additional functionality and compatibility with Cradle\n\n:::warning\nThis is used internally by Cradle, and is not recommended to be used by the user.\n:::",
    "private": true,
    "source": {
        "line": 34,
        "path": "src/Util/RemoteComm/_RemoteFunction.lua"
    }
}