Skip to main content

ClientCustomRemote

This item only works when running on the client. Client

Serves as a middleware for handling RemoteObject RemoteEvents.

This class is not intended for end user usage. It is used internally by the TableReplicator class.

Functions​

Fire​

</>
ClientCustomRemote:Fire(...: any) → ()

Fires to the server

FireUnreliable​

</>
ClientCustomRemote:FireUnreliable(...: any) → ()

Fires this as an unreliable event to the server

Connect​

</>
ClientCustomRemote:Connect(callback: (...any) → ()) → Connection

Connects to the event and waits for the server to fire to the client

Once​

</>
ClientCustomRemote:Once(callback: (...any) → ()) → Connection

Connects to the event and waits for the server to fire to the client one time and then disconnects

Wait​

</>
ClientCustomRemote:Wait() → ...any

Waits for any or a specified client to fire to the server

Show raw api
{
    "functions": [
        {
            "name": "_FireClient",
            "desc": "",
            "params": [
                {
                    "name": "...",
                    "desc": "",
                    "lua_type": "any"
                }
            ],
            "returns": [],
            "function_type": "method",
            "private": true,
            "source": {
                "line": 77,
                "path": "src/tablereplicator/src/Client/ClientCustomRemote.lua"
            }
        },
        {
            "name": "Fire",
            "desc": "Fires to the server",
            "params": [
                {
                    "name": "...",
                    "desc": "",
                    "lua_type": "any"
                }
            ],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 84,
                "path": "src/tablereplicator/src/Client/ClientCustomRemote.lua"
            }
        },
        {
            "name": "FireUnreliable",
            "desc": "Fires this as an unreliable event to the server",
            "params": [
                {
                    "name": "...",
                    "desc": "",
                    "lua_type": "any"
                }
            ],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 98,
                "path": "src/tablereplicator/src/Client/ClientCustomRemote.lua"
            }
        },
        {
            "name": "IsUnreliable",
            "desc": "Returns whether or not this remote is unreliable",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "boolean\n"
                }
            ],
            "function_type": "method",
            "ignore": true,
            "source": {
                "line": 110,
                "path": "src/tablereplicator/src/Client/ClientCustomRemote.lua"
            }
        },
        {
            "name": "Connect",
            "desc": "Connects to the event and waits for the server to fire to the client",
            "params": [
                {
                    "name": "callback",
                    "desc": "",
                    "lua_type": "(...any) -> ()"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Connection\n"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 117,
                "path": "src/tablereplicator/src/Client/ClientCustomRemote.lua"
            }
        },
        {
            "name": "Once",
            "desc": "Connects to the event and waits for the server to fire to the client\none time and then disconnects",
            "params": [
                {
                    "name": "callback",
                    "desc": "",
                    "lua_type": "(...any) -> ()"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Connection\n"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 125,
                "path": "src/tablereplicator/src/Client/ClientCustomRemote.lua"
            }
        },
        {
            "name": "Wait",
            "desc": "Waits for any or a specified client to fire to the server",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "...any"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 132,
                "path": "src/tablereplicator/src/Client/ClientCustomRemote.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "ClientCustomRemote",
    "desc": "Serves as a middleware for handling RemoteObject RemoteEvents.\n\nThis class is not intended for end user usage. It is used internally by the TableReplicator class.",
    "realm": [
        "Client"
    ],
    "unreleased": true,
    "source": {
        "line": 13,
        "path": "src/tablereplicator/src/Client/ClientCustomRemote.lua"
    }
}