Skip to main content

SaveSlotDataService

Functions​

ObserveActiveSlotId​

</>
SaveSlotDataService.ObserveActiveSlotId(
player: Player
) → Observable.Observable<SaveSlotData.SlotId?>

Observes the player's active slot ID

GetActiveSlotId​

</>
SaveSlotDataService.GetActiveSlotId(
player: Player
) → SaveSlotData.SlotId?

Returns the player's active slot ID

ObserveSlotList​

</>
SaveSlotDataService.ObserveSlotList(
player: Player
) → Observable.Observable<{SaveSlotData.SaveSlotMetadata}?>

Observes the player's active slot list

GetSlotList​

</>
SaveSlotDataService.GetSlotList(
player: Player
) → {SaveSlotData.SaveSlotMetadata}

Returns the player's slot list

ObserveSlotMetadata​

</>
SaveSlotDataService.ObserveSlotMetadata(
player: Player,
slotId: SaveSlotData.SlotId
) → Observable.Observable<SaveSlotData.SaveSlotMetadata?>

Observes the slot metadata with the given ID for the player

GetSlotMetadata​

</>
SaveSlotDataService.GetSlotMetadata(
player: Player,
slotId: SaveSlotData.SlotId
) → SaveSlotData.SaveSlotMetadata?

Returns the slot metadata with the given ID for the player

GetSlotIdFromIndex​

</>
SaveSlotDataService.GetSlotIdFromIndex(
player: Player,
slotIndex: number
) → SaveSlotData.SlotId?

Returns the ID for the slot at the given index

Show raw api
{
    "functions": [
        {
            "name": "ObserveActiveSlotId",
            "desc": "Observes the player's active slot ID",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "SaveSlotDataService"
                },
                {
                    "name": "player",
                    "desc": "",
                    "lua_type": "Player\n"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Observable.Observable<SaveSlotData.SlotId?>\n"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 44,
                "path": "src/saveslot/src/Shared/SaveSlotDataService.lua"
            }
        },
        {
            "name": "GetActiveSlotId",
            "desc": "Returns the player's active slot ID",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "SaveSlotDataService"
                },
                {
                    "name": "player",
                    "desc": "",
                    "lua_type": "Player"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "SaveSlotData.SlotId?\n"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 59,
                "path": "src/saveslot/src/Shared/SaveSlotDataService.lua"
            }
        },
        {
            "name": "ObserveSlotList",
            "desc": "Observes the player's active slot list",
            "params": [
                {
                    "name": "_self",
                    "desc": "",
                    "lua_type": "SaveSlotDataService"
                },
                {
                    "name": "player",
                    "desc": "",
                    "lua_type": "Player\n"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Observable.Observable<{ SaveSlotData.SaveSlotMetadata }?>\n"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 67,
                "path": "src/saveslot/src/Shared/SaveSlotDataService.lua"
            }
        },
        {
            "name": "GetSlotList",
            "desc": "Returns the player's slot list",
            "params": [
                {
                    "name": "_self",
                    "desc": "",
                    "lua_type": "SaveSlotDataService"
                },
                {
                    "name": "player",
                    "desc": "",
                    "lua_type": "Player"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "{ SaveSlotData.SaveSlotMetadata }\n"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 89,
                "path": "src/saveslot/src/Shared/SaveSlotDataService.lua"
            }
        },
        {
            "name": "ObserveSlotMetadata",
            "desc": "Observes the slot metadata with the given ID for the player",
            "params": [
                {
                    "name": "_self",
                    "desc": "",
                    "lua_type": "SaveSlotDataService"
                },
                {
                    "name": "player",
                    "desc": "",
                    "lua_type": "Player"
                },
                {
                    "name": "slotId",
                    "desc": "",
                    "lua_type": "SaveSlotData.SlotId\n"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Observable.Observable<SaveSlotData.SaveSlotMetadata?>\n"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 105,
                "path": "src/saveslot/src/Shared/SaveSlotDataService.lua"
            }
        },
        {
            "name": "GetSlotMetadata",
            "desc": "Returns the slot metadata with the given ID for the player",
            "params": [
                {
                    "name": "_self",
                    "desc": "",
                    "lua_type": "SaveSlotDataService"
                },
                {
                    "name": "player",
                    "desc": "",
                    "lua_type": "Player"
                },
                {
                    "name": "slotId",
                    "desc": "",
                    "lua_type": "SaveSlotData.SlotId\n"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "SaveSlotData.SaveSlotMetadata?\n"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 126,
                "path": "src/saveslot/src/Shared/SaveSlotDataService.lua"
            }
        },
        {
            "name": "GetSlotIdFromIndex",
            "desc": "Returns the ID for the slot at the given index",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "SaveSlotDataService"
                },
                {
                    "name": "player",
                    "desc": "",
                    "lua_type": "Player"
                },
                {
                    "name": "slotIndex",
                    "desc": "",
                    "lua_type": "number\n"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "SaveSlotData.SlotId?\n"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 144,
                "path": "src/saveslot/src/Shared/SaveSlotDataService.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "SaveSlotDataService",
    "desc": "",
    "source": {
        "line": 5,
        "path": "src/saveslot/src/Shared/SaveSlotDataService.lua"
    }
}