Skip to main content

RemoteUnreliableEvent

Unreliable Remote Event wrapper adding additional functionality and compatibility with Cradle.

Functions​

new​

This item only works when running on the server. Server
</>
RemoteUnreliableEvent.new() → UnreliableRemoteEvent

Creates a new UnreliableRemoteEvent instance, this is used to replicate events across the server and client. This is an unreliable version of RemoteEvent, meaning that it is not guaranteed to be received by the client. However, it is faster than RemoteEvent, and is useful for events that are not critical to the game's functionality.

Connect​

This item only works when running on the client. ClientThis item only works when running on the server. Server
</>
RemoteUnreliableEvent:Connect(func: function) → RBXScriptConnection

Connects a function to the UnreliableRemoteEvent's OnServerEvent event.

Usage
local remoteUnreliableEvent = RemoteUnreliableEvent.new()

-- Server
remoteUnreliableEvent:Connect(function(player, ...)
	print(player, ...)
end)

-- Client
remoteUnreliableEvent:Connect(function(...)
	print(...)
end)

FireClient​

This item only works when running on the server. Server
</>
RemoteUnreliableEvent:FireClient(
player: Player,
...: any
) → nil

Fires the UnreliableRemoteEvent's OnClientEvent event for a specific player.

Usage
local remoteUnreliableEvent = RemoteUnreliableEvent.new()
remoteUnreliableEvent:FireClient(player, "Hello World!")

FireAllClients​

This item only works when running on the server. Server
</>
RemoteUnreliableEvent:FireAllClients(...: any) → nil

Fires the UnreliableRemoteUnreliableEvent's OnClientEvent event for all players.

Usage
local remoteUnreliableEvent = RemoteUnreliableEvent.new()
remoteUnreliableEvent:FireAllClients("Hello World!")

FireClientsList​

This item only works when running on the server. Server
</>
RemoteUnreliableEvent:FireClientsList(
playerList: table,
...: any
) → nil

Fires the UnreliableRemoteEvent's OnClientEvent event for a list of players.

Usage
local remoteUnreliableEvent = RemoteUnreliableEvent.new()
remoteUnreliableEvent:FireClientsList({ player1, player2 }, "Hello World!")

FireAllClientsExcept​

This item only works when running on the server. Server
</>
RemoteUnreliableEvent:FireAllClientsExcept(
exceptionPlayerOrList: Player | table,
...: any
) → nil

Fires the UnreliableRemoteEvent's OnClientEvent event for all players except for the specified player(s).

Usage
local remoteUnreliableEvent = RemoteUnreliableEvent.new()
remoteUnreliableEvent:FireAllClientsExcept(player, "Hello World!")
remoteUnreliableEvent:FireAllClientsExcept({ player1, player2 }, "Hello World!")

AddMiddleware​

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

Adds a middleware function to the UnreliableRemoteEvent. This function will be called before the OnServerEvent function, and can be used to modify the arguments passed to the OnServerEvent function.

Usage
local remoteUnreliableEvent = RemoteUnreliableEvent.new()
remoteUnreliableEvent:AddMiddleware(1, function(remote, player, ...)
	-- Code here
	print(player, ...)
end)

FireServer​

This item only works when running on the client. Client
</>
RemoteUnreliableEvent:FireServer(...: any) → nil

Fires the UnreliableRemoteEvent's OnServerEvent event.

Usage
local remoteUnreliableEvent = RemoteUnreliableEvent.new()
remoteUnreliableEvent:FireServer("Hello World!")
Show raw api
{
    "functions": [
        {
            "name": "new",
            "desc": "Creates a new UnreliableRemoteEvent instance, this is used to replicate events across the server and client.\nThis is an unreliable version of RemoteEvent, meaning that it is not guaranteed to be received by the client.\nHowever, it is faster than RemoteEvent, and is useful for events that are not critical to the game's functionality.\n\t",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "UnreliableRemoteEvent"
                }
            ],
            "function_type": "static",
            "realm": [
                "Server"
            ],
            "source": {
                "line": 53,
                "path": "src/Util/RemoteComm/_RemoteUnreliableEvent.lua"
            }
        },
        {
            "name": "Connect",
            "desc": "Connects a function to the UnreliableRemoteEvent's OnServerEvent event.\n\n:::note Usage\n```lua\nlocal remoteUnreliableEvent = RemoteUnreliableEvent.new()\n\n-- Server\nremoteUnreliableEvent:Connect(function(player, ...)\n\tprint(player, ...)\nend)\n\n-- Client\nremoteUnreliableEvent:Connect(function(...)\n\tprint(...)\nend)\n```\n\t",
            "params": [
                {
                    "name": "func",
                    "desc": "",
                    "lua_type": "function"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "RBXScriptConnection"
                }
            ],
            "function_type": "method",
            "realm": [
                "Client",
                "Server"
            ],
            "source": {
                "line": 94,
                "path": "src/Util/RemoteComm/_RemoteUnreliableEvent.lua"
            }
        },
        {
            "name": "FireClient",
            "desc": "Fires the UnreliableRemoteEvent's OnClientEvent event for a specific player.\n\n:::note Usage\n```lua\nlocal remoteUnreliableEvent = RemoteUnreliableEvent.new()\nremoteUnreliableEvent:FireClient(player, \"Hello World!\")\n```\n:::\n\t",
            "params": [
                {
                    "name": "player",
                    "desc": "",
                    "lua_type": "Player"
                },
                {
                    "name": "...",
                    "desc": "",
                    "lua_type": "any"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "nil"
                }
            ],
            "function_type": "method",
            "realm": [
                "Server"
            ],
            "source": {
                "line": 115,
                "path": "src/Util/RemoteComm/_RemoteUnreliableEvent.lua"
            }
        },
        {
            "name": "FireAllClients",
            "desc": "Fires the UnreliableRemoteUnreliableEvent's OnClientEvent event for all players.\n\n:::note Usage\n```lua\nlocal remoteUnreliableEvent = RemoteUnreliableEvent.new()\nremoteUnreliableEvent:FireAllClients(\"Hello World!\")\n```\n:::\n\t",
            "params": [
                {
                    "name": "...",
                    "desc": "",
                    "lua_type": "any"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "nil"
                }
            ],
            "function_type": "method",
            "realm": [
                "Server"
            ],
            "source": {
                "line": 135,
                "path": "src/Util/RemoteComm/_RemoteUnreliableEvent.lua"
            }
        },
        {
            "name": "FireClientsList",
            "desc": "Fires the UnreliableRemoteEvent's OnClientEvent event for a list of players.\n\n:::note Usage\n```lua\nlocal remoteUnreliableEvent = RemoteUnreliableEvent.new()\nremoteUnreliableEvent:FireClientsList({ player1, player2 }, \"Hello World!\")\n```\n:::\n\t",
            "params": [
                {
                    "name": "playerList",
                    "desc": "",
                    "lua_type": "table"
                },
                {
                    "name": "...",
                    "desc": "",
                    "lua_type": "any"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "nil"
                }
            ],
            "function_type": "method",
            "realm": [
                "Server"
            ],
            "source": {
                "line": 156,
                "path": "src/Util/RemoteComm/_RemoteUnreliableEvent.lua"
            }
        },
        {
            "name": "FireAllClientsExcept",
            "desc": "Fires the UnreliableRemoteEvent's OnClientEvent event for all players except for the specified player(s).\n\n:::note Usage\n```lua\nlocal remoteUnreliableEvent = RemoteUnreliableEvent.new()\nremoteUnreliableEvent:FireAllClientsExcept(player, \"Hello World!\")\nremoteUnreliableEvent:FireAllClientsExcept({ player1, player2 }, \"Hello World!\")\n```\n:::\n\t",
            "params": [
                {
                    "name": "exceptionPlayerOrList",
                    "desc": "",
                    "lua_type": "Player | table"
                },
                {
                    "name": "...",
                    "desc": "",
                    "lua_type": "any"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "nil"
                }
            ],
            "function_type": "method",
            "realm": [
                "Server"
            ],
            "source": {
                "line": 180,
                "path": "src/Util/RemoteComm/_RemoteUnreliableEvent.lua"
            }
        },
        {
            "name": "AddMiddleware",
            "desc": "Adds a middleware function to the UnreliableRemoteEvent. This function will be called before the OnServerEvent function, and can be used to modify the arguments passed to the OnServerEvent function.\n\n:::note Usage\n```lua\nlocal remoteUnreliableEvent = RemoteUnreliableEvent.new()\nremoteUnreliableEvent:AddMiddleware(1, function(remote, player, ...)\n\t-- Code here\n\tprint(player, ...)\nend)\n```\n:::\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": 219,
                "path": "src/Util/RemoteComm/_RemoteUnreliableEvent.lua"
            }
        },
        {
            "name": "new",
            "desc": "Connects to an existing UnreliableRemoteEvent instance, this is used to replicate events across the server and client.\n\n:::warning\nThis only to be used internally to link to an existing RemoteUnreliableEvent instance, creating a new RemoteUnreliableEvent instance on the client is not possible.\n:::\n\t",
            "params": [
                {
                    "name": "inst",
                    "desc": "",
                    "lua_type": "Instance"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "UnreliableRemoteEvent"
                }
            ],
            "function_type": "static",
            "realm": [
                "Client"
            ],
            "private": true,
            "source": {
                "line": 239,
                "path": "src/Util/RemoteComm/_RemoteUnreliableEvent.lua"
            }
        },
        {
            "name": "Connect",
            "desc": "Connects a function to the UnreliableRemoteEvent's OnClientEvent event.\n\n:::note Usage\n```lua\nlocal remoteUnreliableEvent = RemoteUnreliableEvent.new()\nremoteUnreliableEvent:Connect(function(...)\n\tprint(...)\nend)\n```\n:::\n\t",
            "params": [
                {
                    "name": "func",
                    "desc": "",
                    "lua_type": "function"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "RBXScriptConnection"
                }
            ],
            "function_type": "method",
            "realm": [
                "Client"
            ],
            "ignore": true,
            "source": {
                "line": 266,
                "path": "src/Util/RemoteComm/_RemoteUnreliableEvent.lua"
            }
        },
        {
            "name": "FireServer",
            "desc": "Fires the UnreliableRemoteEvent's OnServerEvent event.\n\n:::note Usage\n```lua\nlocal remoteUnreliableEvent = RemoteUnreliableEvent.new()\nremoteUnreliableEvent:FireServer(\"Hello World!\")\n```\n:::\n\t",
            "params": [
                {
                    "name": "...",
                    "desc": "",
                    "lua_type": "any"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "nil"
                }
            ],
            "function_type": "method",
            "realm": [
                "Client"
            ],
            "source": {
                "line": 286,
                "path": "src/Util/RemoteComm/_RemoteUnreliableEvent.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "RemoteUnreliableEvent",
    "desc": "Unreliable Remote Event wrapper adding additional functionality and compatibility with Cradle.",
    "source": {
        "line": 34,
        "path": "src/Util/RemoteComm/_RemoteUnreliableEvent.lua"
    }
}