Skip to main content

TeleportServiceUtils

Functions​

promiseReserveServer​

</>
TeleportServiceUtils.promiseReserveServer(placeId: number) → Promise<string>--

Code

Wraps TeleportService:ReserveServer(placeId)

promiseTeleport​

</>
TeleportServiceUtils.promiseTeleport(
placeId: number,
players: {Player},
teleportOptions: TeleportOptions
) → Promise<string>--

Code

Wraps TeleportService:PromiseTeleport(placeId, players, teleportOptions)

Show raw api
{
    "functions": [
        {
            "name": "promiseReserveServer",
            "desc": "Wraps TeleportService:ReserveServer(placeId)",
            "params": [
                {
                    "name": "placeId",
                    "desc": "",
                    "lua_type": "number"
                }
            ],
            "returns": [
                {
                    "desc": "Code",
                    "lua_type": "Promise<string>"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 18,
                "path": "src/teleportserviceutils/src/Server/TeleportServiceUtils.lua"
            }
        },
        {
            "name": "promiseTeleport",
            "desc": "Wraps TeleportService:PromiseTeleport(placeId, players, teleportOptions)",
            "params": [
                {
                    "name": "placeId",
                    "desc": "",
                    "lua_type": "number"
                },
                {
                    "name": "players",
                    "desc": "",
                    "lua_type": "{ Player }"
                },
                {
                    "name": "teleportOptions",
                    "desc": "",
                    "lua_type": "TeleportOptions"
                }
            ],
            "returns": [
                {
                    "desc": "Code",
                    "lua_type": "Promise<string>"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 41,
                "path": "src/teleportserviceutils/src/Server/TeleportServiceUtils.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "TeleportServiceUtils",
    "desc": "",
    "source": {
        "line": 4,
        "path": "src/teleportserviceutils/src/Server/TeleportServiceUtils.lua"
    }
}