Skip to main content

HasSaveSlotsClient

Functions​

PromiseHasSlot​

</>
HasSaveSlotsClient.PromiseHasSlot(
slotId: SaveSlotData.SlotId?
) → Promise.Promise<boolean>

Returns whether the slot with the given ID exists

PromiseSelectSlot​

</>
HasSaveSlotsClient.PromiseSelectSlot(
slotId: SaveSlotData.SlotId
) → Promise.Promise<any>

Selects the slot with the given ID

PromiseCreateSlot​

</>
HasSaveSlotsClient.PromiseCreateSlot(
slotIndex: number,
metadata: SaveSlotData.SaveSlotMetadata?
) → Promise.Promise<any>

Creates a slot at the given index

PromiseDeleteSlot​

</>
HasSaveSlotsClient.PromiseDeleteSlot(
slotId: SaveSlotData.SlotId
) → Promise.Promise<any>

Deletes the slot with the given ID

PromiseSetSlotMetadata​

</>
HasSaveSlotsClient.PromiseSetSlotMetadata(
slotId: SaveSlotData.SlotId,
data: SaveSlotData.SaveSlotMetadata
) → Promise.Promise<any>

Sets the metadata for the slot with the given ID

PromiseGetSlotMetadata​

</>
HasSaveSlotsClient.PromiseGetSlotMetadata(
slotId: SaveSlotData.SlotId
) → Promise.Promise<SaveSlotData.SaveSlotMetadata?>

Gets the metadata for the slot with the given ID

PromiseLastActiveSlotId​

</>
HasSaveSlotsClient.PromiseLastActiveSlotId(self: HasSaveSlotsClient) → Promise.Promise<SaveSlotData.SlotId?>

Gets the last active slot ID

PromiseDeselectSlot​

</>
HasSaveSlotsClient.PromiseDeselectSlot(self: HasSaveSlotsClient) → Promise.Promise<()>

Clears the active slot selection, returning the player to a no-slot state

PromiseSlotIdFromIndex​

</>
HasSaveSlotsClient.PromiseSlotIdFromIndex(
slotIndex: number
) → Promise.Promise<SaveSlotData.SlotId?>

Returns the slot ID from the given index

Show raw api
{
    "functions": [
        {
            "name": "PromiseHasSlot",
            "desc": "Returns whether the slot with the given ID exists",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "HasSaveSlotsClient"
                },
                {
                    "name": "slotId",
                    "desc": "",
                    "lua_type": "SaveSlotData.SlotId?\n"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Promise.Promise<boolean>\n"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 57,
                "path": "src/saveslot/src/Client/Binders/HasSaveSlotsClient.lua"
            }
        },
        {
            "name": "PromiseSelectSlot",
            "desc": "Selects the slot with the given ID",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "HasSaveSlotsClient"
                },
                {
                    "name": "slotId",
                    "desc": "",
                    "lua_type": "SaveSlotData.SlotId\n"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Promise.Promise<any>\n"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 67,
                "path": "src/saveslot/src/Client/Binders/HasSaveSlotsClient.lua"
            }
        },
        {
            "name": "PromiseCreateSlot",
            "desc": "Creates a slot at the given index",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "HasSaveSlotsClient"
                },
                {
                    "name": "slotIndex",
                    "desc": "",
                    "lua_type": "number"
                },
                {
                    "name": "metadata",
                    "desc": "",
                    "lua_type": "SaveSlotData.SaveSlotMetadata?\n"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Promise.Promise<any>\n"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 77,
                "path": "src/saveslot/src/Client/Binders/HasSaveSlotsClient.lua"
            }
        },
        {
            "name": "PromiseDeleteSlot",
            "desc": "Deletes the slot with the given ID",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "HasSaveSlotsClient"
                },
                {
                    "name": "slotId",
                    "desc": "",
                    "lua_type": "SaveSlotData.SlotId\n"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Promise.Promise<any>\n"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 88,
                "path": "src/saveslot/src/Client/Binders/HasSaveSlotsClient.lua"
            }
        },
        {
            "name": "PromiseSetSlotMetadata",
            "desc": "Sets the metadata for the slot with the given ID",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "HasSaveSlotsClient"
                },
                {
                    "name": "slotId",
                    "desc": "",
                    "lua_type": "SaveSlotData.SlotId"
                },
                {
                    "name": "data",
                    "desc": "",
                    "lua_type": "SaveSlotData.SaveSlotMetadata\n"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Promise.Promise<any>\n"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 98,
                "path": "src/saveslot/src/Client/Binders/HasSaveSlotsClient.lua"
            }
        },
        {
            "name": "PromiseGetSlotMetadata",
            "desc": "Gets the metadata for the slot with the given ID",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "HasSaveSlotsClient"
                },
                {
                    "name": "slotId",
                    "desc": "",
                    "lua_type": "SaveSlotData.SlotId\n"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Promise.Promise<SaveSlotData.SaveSlotMetadata?>\n"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 109,
                "path": "src/saveslot/src/Client/Binders/HasSaveSlotsClient.lua"
            }
        },
        {
            "name": "PromiseLastActiveSlotId",
            "desc": "Gets the last active slot ID",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "HasSaveSlotsClient"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Promise.Promise<SaveSlotData.SlotId?>\n"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 119,
                "path": "src/saveslot/src/Client/Binders/HasSaveSlotsClient.lua"
            }
        },
        {
            "name": "PromiseDeselectSlot",
            "desc": "Clears the active slot selection, returning the player to a no-slot state",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "HasSaveSlotsClient"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Promise.Promise<()>\n"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 126,
                "path": "src/saveslot/src/Client/Binders/HasSaveSlotsClient.lua"
            }
        },
        {
            "name": "PromiseSlotIdFromIndex",
            "desc": "Returns the slot ID from the given index",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "HasSaveSlotsClient"
                },
                {
                    "name": "slotIndex",
                    "desc": "",
                    "lua_type": "number\n"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Promise.Promise<SaveSlotData.SlotId?>\n"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 133,
                "path": "src/saveslot/src/Client/Binders/HasSaveSlotsClient.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "HasSaveSlotsClient",
    "desc": "",
    "source": {
        "line": 5,
        "path": "src/saveslot/src/Client/Binders/HasSaveSlotsClient.lua"
    }
}