Skip to main content

ServerEvent

Functions​

new​

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

Fire​

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

FirePlayers​

</>
ServerEvent:FirePlayers(
players: {Player},
...: any
) → ()

Broadcast​

</>
ServerEvent:Broadcast(...: any) → ()

AddMiddleware​

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

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

SetCallback​

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

What is expected from the client

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

Sets the callback for the event.

Predict​

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

Fire an event from 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": "ServerEvent"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 36,
                "path": "Source/Networking/Classes/Server.luau"
            }
        },
        {
            "name": "Fire",
            "desc": "",
            "params": [
                {
                    "name": "player",
                    "desc": "",
                    "lua_type": "Player"
                },
                {
                    "name": "...",
                    "desc": "",
                    "lua_type": "any"
                }
            ],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 50,
                "path": "Source/Networking/Classes/Server.luau"
            }
        },
        {
            "name": "FirePlayers",
            "desc": "",
            "params": [
                {
                    "name": "players",
                    "desc": "",
                    "lua_type": "{Player}"
                },
                {
                    "name": "...",
                    "desc": "",
                    "lua_type": "any"
                }
            ],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 60,
                "path": "Source/Networking/Classes/Server.luau"
            }
        },
        {
            "name": "Broadcast",
            "desc": "",
            "params": [
                {
                    "name": "...",
                    "desc": "",
                    "lua_type": "any"
                }
            ],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 71,
                "path": "Source/Networking/Classes/Server.luau"
            }
        },
        {
            "name": "AddMiddleware",
            "desc": "Adds a new middleware function to run when the event is fired",
            "params": [
                {
                    "name": "fn",
                    "desc": "",
                    "lua_type": "MiddlewareFn"
                }
            ],
            "returns": [],
            "function_type": "method",
            "since": "v1.1.0",
            "source": {
                "line": 83,
                "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": 96,
                "path": "Source/Networking/Classes/Server.luau"
            }
        },
        {
            "name": "Predict",
            "desc": "Fire an event from 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": 152,
                "path": "Source/Networking/Classes/Server.luau"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "ServerEvent",
    "desc": "",
    "source": {
        "line": 10,
        "path": "Source/Networking/Classes/Server.luau"
    }
}