Skip to main content

SaveSlotServiceClient

Functions​

PromiseIsInternalTeleport​

</>
SaveSlotServiceClient.PromiseIsInternalTeleport(self: SaveSlotServiceClient) → Promise<boolean>

Resolves whether the local player teleported in carrying a save-slot id -- i.e. arrived via an internal slot teleport rather than a fresh join. Presence-only. A promise for symmetry with the server's SaveSlotService.PromiseIsInternalTeleport; on the client it resolves immediately from local teleport data.

GetExplicitSelectionRequiredAsync​

</>
SaveSlotServiceClient.GetExplicitSelectionRequiredAsync(self: SaveSlotServiceClient) → boolean

Returns whether explicit slot selection is required

Destroy​

</>
SaveSlotServiceClient.Destroy(self: SaveSlotServiceClient) → ()

Destroys the service

Show raw api
{
    "functions": [
        {
            "name": "PromiseIsInternalTeleport",
            "desc": "Resolves whether the local player teleported in carrying a save-slot id -- i.e. arrived via an\ninternal slot teleport rather than a fresh join. Presence-only. A promise for symmetry with the\nserver's [SaveSlotService.PromiseIsInternalTeleport]; on the client it resolves immediately from\nlocal teleport data.",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "SaveSlotServiceClient"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Promise<boolean>"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 80,
                "path": "src/saveslot/src/Client/SaveSlotServiceClient.lua"
            }
        },
        {
            "name": "GetExplicitSelectionRequiredAsync",
            "desc": "Returns whether explicit slot selection is required",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "SaveSlotServiceClient"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "boolean\n"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 87,
                "path": "src/saveslot/src/Client/SaveSlotServiceClient.lua"
            }
        },
        {
            "name": "Destroy",
            "desc": "Destroys the service",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "SaveSlotServiceClient"
                }
            ],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 94,
                "path": "src/saveslot/src/Client/SaveSlotServiceClient.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "SaveSlotServiceClient",
    "desc": "",
    "source": {
        "line": 5,
        "path": "src/saveslot/src/Client/SaveSlotServiceClient.lua"
    }
}