Skip to main content

HasSaveSlotsBase

Functions​

PromiseIncomingSlotId​

</>
HasSaveSlotsBase.PromiseIncomingSlotId(_self: HasSaveSlotsBase) → Promise<SaveSlotData.SlotId?>

Resolves the save-slot id the player teleported in with, or nil. Realm hook: the server reads it from the client-replicated teleport data, the client from the local player's teleport data (both via the TeleportDataService unified read, which is a promise because the server must wait for the client to replicate). The base default resolves nil so a realm that never sets one degrades to "no incoming slot".

PromiseHasSaveSlotFromTeleport​

</>
HasSaveSlotsBase.PromiseHasSaveSlotFromTeleport(self: HasSaveSlotsBase) → Promise<boolean>

Returns whether the player teleported in carrying a save-slot id that still exists for them. This is the existence-validated form of "internal teleport".

PromiseLoadSaveSlotFromTeleport​

</>
HasSaveSlotsBase.PromiseLoadSaveSlotFromTeleport(self: HasSaveSlotsBase) → Promise<SaveSlotData.SlotId?>

Selects the save slot the player teleported in with when it still exists, resolving to that slot id -- or nil when there was no incoming slot or it no longer exists. Reuses the realm's own PromiseHasSlot/PromiseSelectSlot, so it works identically on server and client.

Show raw api
{
    "functions": [
        {
            "name": "PromiseIncomingSlotId",
            "desc": "Resolves the save-slot id the player teleported in with, or nil. Realm hook: the server reads it from\nthe client-replicated teleport data, the client from the local player's teleport data (both via the\n[TeleportDataService] unified read, which is a promise because the server must wait for the client to\nreplicate). The base default resolves nil so a realm that never sets one degrades to \"no incoming\nslot\".",
            "params": [
                {
                    "name": "_self",
                    "desc": "",
                    "lua_type": "HasSaveSlotsBase"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Promise<SaveSlotData.SlotId?>"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 64,
                "path": "src/saveslot/src/Shared/HasSaveSlotsBase.lua"
            }
        },
        {
            "name": "PromiseHasSaveSlotFromTeleport",
            "desc": "Returns whether the player teleported in carrying a save-slot id that still exists for them.\nThis is the existence-validated form of \"internal teleport\".",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "HasSaveSlotsBase"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Promise<boolean>"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 74,
                "path": "src/saveslot/src/Shared/HasSaveSlotsBase.lua"
            }
        },
        {
            "name": "PromiseLoadSaveSlotFromTeleport",
            "desc": "Selects the save slot the player teleported in with when it still exists, resolving to that slot\nid -- or nil when there was no incoming slot or it no longer exists. Reuses the realm's own\n`PromiseHasSlot`/`PromiseSelectSlot`, so it works identically on server and client.",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "HasSaveSlotsBase"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Promise<SaveSlotData.SlotId?>"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 91,
                "path": "src/saveslot/src/Shared/HasSaveSlotsBase.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "HasSaveSlotsBase",
    "desc": "",
    "source": {
        "line": 5,
        "path": "src/saveslot/src/Shared/HasSaveSlotsBase.lua"
    }
}