Skip to main content

SaveSlotService

Functions​

RequireExplicitSelection​

</>
SaveSlotService.RequireExplicitSelection(self: SaveSlotService) → ()

Requires explicit slot selection

GetExplicitSelectionRequired​

</>
SaveSlotService.GetExplicitSelectionRequired(self: SaveSlotService) → boolean

Returns whether explicit slot selection is required

SetMaxSlotCount​

</>
SaveSlotService.SetMaxSlotCount(
maxSlotCount: number
) → ()

Sets the max slot count

SetDefaultSummaryProvider​

</>
SaveSlotService.SetDefaultSummaryProvider(
provider: HasSaveSlots.SaveSlotSummaryProvider
) → ()

Sets the default slot summary provider

ObserveActiveSlotStoreBrio​

</>
SaveSlotService.ObserveActiveSlotStoreBrio(
player: Player
) → Observable.Observable<Brio.Brio<DataStoreStage.DataStoreStage>>

Observes the DataStoreStage for the player's active slot as a Brio

PromiseActiveSlotStore​

</>
SaveSlotService.PromiseActiveSlotStore(
player: Player
) → Promise.Promise<DataStoreStage.DataStoreStage?>

Returns the DataStoreStage for the player's active slot

PromiseHasSlot​

</>
SaveSlotService.PromiseHasSlot(
player: Player,
slotId: SaveSlotData.SlotId
) → Promise.Promise<boolean>

Returns whether the player has a slot with the given ID

PromiseSelectSlot​

</>
SaveSlotService.PromiseSelectSlot(
player: Player,
slotId: SaveSlotData.SlotId
) → Promise.Promise<DataStoreStage.DataStoreStage>

Selects the slot with the given ID for the player

PromiseCreateSlot​

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

Creates a slot for the player at the given index

PromiseDeleteSlot​

</>
SaveSlotService.PromiseDeleteSlot(
player: Player,
slotId: SaveSlotData.SlotId
) → Promise.Promise<any>

Deletes the slot with the given ID for the player

Destroy​

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

Destroys the service

Show raw api
{
    "functions": [
        {
            "name": "RequireExplicitSelection",
            "desc": "Requires explicit slot selection",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "SaveSlotService"
                }
            ],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 111,
                "path": "src/saveslot/src/Server/SaveSlotService.lua"
            }
        },
        {
            "name": "GetExplicitSelectionRequired",
            "desc": "Returns whether explicit slot selection is required",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "SaveSlotService"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "boolean\n"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 119,
                "path": "src/saveslot/src/Server/SaveSlotService.lua"
            }
        },
        {
            "name": "SetMaxSlotCount",
            "desc": "Sets the max slot count",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "SaveSlotService"
                },
                {
                    "name": "maxSlotCount",
                    "desc": "",
                    "lua_type": "number"
                }
            ],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 126,
                "path": "src/saveslot/src/Server/SaveSlotService.lua"
            }
        },
        {
            "name": "SetDefaultSummaryProvider",
            "desc": "Sets the default slot summary provider",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "SaveSlotService"
                },
                {
                    "name": "provider",
                    "desc": "",
                    "lua_type": "HasSaveSlots.SaveSlotSummaryProvider\n"
                }
            ],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 135,
                "path": "src/saveslot/src/Server/SaveSlotService.lua"
            }
        },
        {
            "name": "ObserveActiveSlotStoreBrio",
            "desc": "Observes the [DataStoreStage] for the player's active slot as a [Brio]",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "SaveSlotService"
                },
                {
                    "name": "player",
                    "desc": "",
                    "lua_type": "Player\n"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Observable.Observable<Brio.Brio<DataStoreStage.DataStoreStage>>\n"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 146,
                "path": "src/saveslot/src/Server/SaveSlotService.lua"
            }
        },
        {
            "name": "PromiseActiveSlotStore",
            "desc": "Returns the [DataStoreStage] for the player's active slot",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "SaveSlotService"
                },
                {
                    "name": "player",
                    "desc": "",
                    "lua_type": "Player\n"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Promise.Promise<DataStoreStage.DataStoreStage?>\n"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 160,
                "path": "src/saveslot/src/Server/SaveSlotService.lua"
            }
        },
        {
            "name": "PromiseHasSlot",
            "desc": "Returns whether the player has a slot with the given ID",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "SaveSlotService"
                },
                {
                    "name": "player",
                    "desc": "",
                    "lua_type": "Player"
                },
                {
                    "name": "slotId",
                    "desc": "",
                    "lua_type": "SaveSlotData.SlotId\n"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Promise.Promise<boolean>\n"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 172,
                "path": "src/saveslot/src/Server/SaveSlotService.lua"
            }
        },
        {
            "name": "PromiseSelectSlot",
            "desc": "Selects the slot with the given ID for the player",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "SaveSlotService"
                },
                {
                    "name": "player",
                    "desc": "",
                    "lua_type": "Player"
                },
                {
                    "name": "slotId",
                    "desc": "",
                    "lua_type": "SaveSlotData.SlotId\n"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Promise.Promise<DataStoreStage.DataStoreStage>\n"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 185,
                "path": "src/saveslot/src/Server/SaveSlotService.lua"
            }
        },
        {
            "name": "PromiseCreateSlot",
            "desc": "Creates a slot for the player at the given index",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "SaveSlotService"
                },
                {
                    "name": "player",
                    "desc": "",
                    "lua_type": "Player"
                },
                {
                    "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": 198,
                "path": "src/saveslot/src/Server/SaveSlotService.lua"
            }
        },
        {
            "name": "PromiseDeleteSlot",
            "desc": "Deletes the slot with the given ID for the player",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "SaveSlotService"
                },
                {
                    "name": "player",
                    "desc": "",
                    "lua_type": "Player"
                },
                {
                    "name": "slotId",
                    "desc": "",
                    "lua_type": "SaveSlotData.SlotId\n"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Promise.Promise<any>\n"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 212,
                "path": "src/saveslot/src/Server/SaveSlotService.lua"
            }
        },
        {
            "name": "Destroy",
            "desc": "Destroys the service",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "SaveSlotService"
                }
            ],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 225,
                "path": "src/saveslot/src/Server/SaveSlotService.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "SaveSlotService",
    "desc": "",
    "source": {
        "line": 5,
        "path": "src/saveslot/src/Server/SaveSlotService.lua"
    }
}