Skip to main content

HasSaveSlots

Functions​

ObserveActiveSlotStoreBrio​

</>
HasSaveSlots.ObserveActiveSlotStoreBrio(self: HasSaveSlots) → Observable.Observable<Brio.Brio<DataStoreStage.DataStoreStage>>

Observes the DataStoreStage for the active slot as a Brio

PromiseActiveSlotStore​

</>
HasSaveSlots.PromiseActiveSlotStore(self: HasSaveSlots) → Promise.Promise<DataStoreStage.DataStoreStage?>

Returns the DataStoreStage for the active slot

PromiseSlotsLoaded​

</>
HasSaveSlots.PromiseSlotsLoaded(self: HasSaveSlots) → Promise.Promise<any>

Promises that all slots have loaded

PromiseHasSlot​

</>
HasSaveSlots.PromiseHasSlot(
self: HasSaveSlots,
slotId: SaveSlotData.SlotId?
) → Promise.Promise<boolean>

Returns whether the slot with the given ID exists

PromiseSelectSlot​

</>
HasSaveSlots.PromiseSelectSlot(
self: HasSaveSlots,
slotId: SaveSlotData.SlotId
) → Promise.Promise<any>

Selects the slot with the given ID

PromiseCreateSlot​

</>
HasSaveSlots.PromiseCreateSlot(
self: HasSaveSlots,
slotIndex: number,
metadata: SaveSlotData.SaveSlotMetadata?
) → Promise.Promise<SaveSlotData.SlotId>

Creates a slot at the given index

PromiseDeleteSlot​

</>
HasSaveSlots.PromiseDeleteSlot(
self: HasSaveSlots,
slotId: SaveSlotData.SlotId
) → Promise.Promise<any>

Deletes the slot with the given ID

PromiseSetSlotMetadata​

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

Sets the metadata for the slot with the given ID

PromiseGetSlotMetadata​

</>
HasSaveSlots.PromiseGetSlotMetadata(
self: HasSaveSlots,
slotId: SaveSlotData.SlotId
) → Promise.Promise<SaveSlotData.SaveSlotMetadata?>

Gets the metadata for the slot with the given ID

PromiseSlotIdFromIndex​

</>
HasSaveSlots.PromiseSlotIdFromIndex(
self: HasSaveSlots,
slotIndex: number
) → Promise.Promise<SaveSlotData.SlotId?>

Returns the slot ID from the given index

PromiseLastActiveSlotId​

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

Gets the last active slot ID

SetSummaryProvider​

</>
HasSaveSlots.SetSummaryProvider(
self: HasSaveSlots,
provider: SaveSlotSummaryProvider?
) → ()

Sets the summary provider

Show raw api
{
    "functions": [
        {
            "name": "ObserveActiveSlotStoreBrio",
            "desc": "Observes the [DataStoreStage] for the active slot as a [Brio]",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "HasSaveSlots\n"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Observable.Observable<Brio.Brio<DataStoreStage.DataStoreStage>>\n"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 84,
                "path": "src/saveslot/src/Server/Binders/HasSaveSlots.lua"
            }
        },
        {
            "name": "PromiseActiveSlotStore",
            "desc": "Returns the [DataStoreStage] for the active slot",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "HasSaveSlots"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Promise.Promise<DataStoreStage.DataStoreStage?>\n"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 105,
                "path": "src/saveslot/src/Server/Binders/HasSaveSlots.lua"
            }
        },
        {
            "name": "PromiseSlotsLoaded",
            "desc": "Promises that all slots have loaded",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "HasSaveSlots"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Promise.Promise<any>\n"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 118,
                "path": "src/saveslot/src/Server/Binders/HasSaveSlots.lua"
            }
        },
        {
            "name": "PromiseHasSlot",
            "desc": "Returns whether the slot with the given ID exists",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "HasSaveSlots"
                },
                {
                    "name": "slotId",
                    "desc": "",
                    "lua_type": "SaveSlotData.SlotId?"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Promise.Promise<boolean>\n"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 125,
                "path": "src/saveslot/src/Server/Binders/HasSaveSlots.lua"
            }
        },
        {
            "name": "PromiseSelectSlot",
            "desc": "Selects the slot with the given ID",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "HasSaveSlots"
                },
                {
                    "name": "slotId",
                    "desc": "",
                    "lua_type": "SaveSlotData.SlotId"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Promise.Promise<any>\n"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 134,
                "path": "src/saveslot/src/Server/Binders/HasSaveSlots.lua"
            }
        },
        {
            "name": "PromiseCreateSlot",
            "desc": "Creates a slot at the given index",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "HasSaveSlots"
                },
                {
                    "name": "slotIndex",
                    "desc": "",
                    "lua_type": "number"
                },
                {
                    "name": "metadata",
                    "desc": "",
                    "lua_type": "SaveSlotData.SaveSlotMetadata?\n"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Promise.Promise<SaveSlotData.SlotId>\n"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 163,
                "path": "src/saveslot/src/Server/Binders/HasSaveSlots.lua"
            }
        },
        {
            "name": "PromiseDeleteSlot",
            "desc": "Deletes the slot with the given ID",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "HasSaveSlots"
                },
                {
                    "name": "slotId",
                    "desc": "",
                    "lua_type": "SaveSlotData.SlotId"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Promise.Promise<any>\n"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 196,
                "path": "src/saveslot/src/Server/Binders/HasSaveSlots.lua"
            }
        },
        {
            "name": "PromiseSetSlotMetadata",
            "desc": "Sets the metadata for the slot with the given ID",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "HasSaveSlots"
                },
                {
                    "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": 232,
                "path": "src/saveslot/src/Server/Binders/HasSaveSlots.lua"
            }
        },
        {
            "name": "PromiseGetSlotMetadata",
            "desc": "Gets the metadata for the slot with the given ID",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "HasSaveSlots"
                },
                {
                    "name": "slotId",
                    "desc": "",
                    "lua_type": "SaveSlotData.SlotId\n"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Promise.Promise<SaveSlotData.SaveSlotMetadata?>\n"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 256,
                "path": "src/saveslot/src/Server/Binders/HasSaveSlots.lua"
            }
        },
        {
            "name": "PromiseSlotIdFromIndex",
            "desc": "Returns the slot ID from the given index",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "HasSaveSlots"
                },
                {
                    "name": "slotIndex",
                    "desc": "",
                    "lua_type": "number\n"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Promise.Promise<SaveSlotData.SlotId?>\n"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 269,
                "path": "src/saveslot/src/Server/Binders/HasSaveSlots.lua"
            }
        },
        {
            "name": "PromiseLastActiveSlotId",
            "desc": "Gets the last active slot ID",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "HasSaveSlots"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Promise.Promise<SaveSlotData.SlotId?>\n"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 286,
                "path": "src/saveslot/src/Server/Binders/HasSaveSlots.lua"
            }
        },
        {
            "name": "SetSummaryProvider",
            "desc": "Sets the summary provider",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "HasSaveSlots"
                },
                {
                    "name": "provider",
                    "desc": "",
                    "lua_type": "SaveSlotSummaryProvider?"
                }
            ],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 295,
                "path": "src/saveslot/src/Server/Binders/HasSaveSlots.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "HasSaveSlots",
    "desc": "",
    "source": {
        "line": 5,
        "path": "src/saveslot/src/Server/Binders/HasSaveSlots.lua"
    }
}