Skip to main content

ServerCustomRemote

This item only works when running on the server. Server

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​

</>
ServerCustomRemote:Fire(
player: Player,
...: any
) → ()

Fires to a specific client

IsUnreliable​

</>
ServerCustomRemote:IsUnreliable() → boolean

Returns whether or not this remote is unreliable

FireAll​

</>
ServerCustomRemote:FireAll(...: any) → ()

Fires to all currently replicated clients

FireExcept​

</>
ServerCustomRemote:FireExcept(
ignoredPlayers: Player | {Player},
...: any
) → ()

Fires to all currently replicated clients except the ones specified

FirePredicate​

</>
ServerCustomRemote:FirePredicate(
predicate: Predicate,
...: any
) → ()

Fires to all currently replicated clients that pass the predicate test

Connect​

</>
ServerCustomRemote:Connect(callback: (
Player: Player,
...any
) → ()) → Connection

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

Once​

</>
ServerCustomRemote:Once(callback: (
Player: Player,
...any
) → ()) → Connection

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

Wait​

</>
ServerCustomRemote:Wait(predicate: (Player | Predicate)?) → (
...any
)

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

Show raw api
{
    "functions": [
        {
            "name": "Fire",
            "desc": "Fires to a specific client",
            "params": [
                {
                    "name": "player",
                    "desc": "",
                    "lua_type": "Player"
                },
                {
                    "name": "...",
                    "desc": "",
                    "lua_type": "any"
                }
            ],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 88,
                "path": "src/tablereplicator/src/Server/ServerCustomRemote.lua"
            }
        },
        {
            "name": "IsUnreliable",
            "desc": "Returns whether or not this remote is unreliable",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "boolean\n"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 114,
                "path": "src/tablereplicator/src/Server/ServerCustomRemote.lua"
            }
        },
        {
            "name": "FireAll",
            "desc": "Fires to all currently replicated clients",
            "params": [
                {
                    "name": "...",
                    "desc": "",
                    "lua_type": "any"
                }
            ],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 121,
                "path": "src/tablereplicator/src/Server/ServerCustomRemote.lua"
            }
        },
        {
            "name": "FireExcept",
            "desc": "Fires to all currently replicated clients except the ones specified",
            "params": [
                {
                    "name": "ignoredPlayers",
                    "desc": "",
                    "lua_type": "Player | {Player}"
                },
                {
                    "name": "...",
                    "desc": "",
                    "lua_type": "any"
                }
            ],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 136,
                "path": "src/tablereplicator/src/Server/ServerCustomRemote.lua"
            }
        },
        {
            "name": "FirePredicate",
            "desc": "Fires to all currently replicated clients that pass the predicate test",
            "params": [
                {
                    "name": "predicate",
                    "desc": "",
                    "lua_type": "Predicate"
                },
                {
                    "name": "...",
                    "desc": "",
                    "lua_type": "any"
                }
            ],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 153,
                "path": "src/tablereplicator/src/Server/ServerCustomRemote.lua"
            }
        },
        {
            "name": "Connect",
            "desc": "Connects to the event and waits for a replicated client to fire to the server",
            "params": [
                {
                    "name": "callback",
                    "desc": "",
                    "lua_type": "(Player: Player, ...any) -> ()"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Connection\n"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 164,
                "path": "src/tablereplicator/src/Server/ServerCustomRemote.lua"
            }
        },
        {
            "name": "Once",
            "desc": "Connects to the event and waits for a replicated client to fire to the server \none time and then disconnects",
            "params": [
                {
                    "name": "callback",
                    "desc": "",
                    "lua_type": "(Player: Player, ...any) -> ()"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Connection\n"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 172,
                "path": "src/tablereplicator/src/Server/ServerCustomRemote.lua"
            }
        },
        {
            "name": "Wait",
            "desc": "Waits for any or a specified client to fire to the server",
            "params": [
                {
                    "name": "predicate",
                    "desc": "",
                    "lua_type": "(Player | Predicate)?"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Player"
                },
                {
                    "desc": "",
                    "lua_type": "...any"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 179,
                "path": "src/tablereplicator/src/Server/ServerCustomRemote.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "ServerCustomRemote",
    "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": [
        "Server"
    ],
    "unreleased": true,
    "source": {
        "line": 13,
        "path": "src/tablereplicator/src/Server/ServerCustomRemote.lua"
    }
}