Skip to main content

Save

Functions​

Get​

</>
Save:Get(
keyPath: KeyPath,
defaultValue:: any?
) → any

Set​

</>
Save:Set(
keyPath: KeyPath,
newValue: any
) → ()

Subscribe​

</>
Save:Subscribe(
keyPath: KeyPath,
listener: (value: any) → (),
immediatelyCallListener: boolean?
) → () → ()
Show raw api
{
    "functions": [
        {
            "name": "Get",
            "desc": "",
            "params": [
                {
                    "name": "keyPath",
                    "desc": "",
                    "lua_type": "KeyPath"
                },
                {
                    "name": "defaultValue:",
                    "desc": "",
                    "lua_type": "any?"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "any"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 55,
                "path": "src/Save.luau"
            }
        },
        {
            "name": "Set",
            "desc": "",
            "params": [
                {
                    "name": "keyPath",
                    "desc": "",
                    "lua_type": "KeyPath"
                },
                {
                    "name": "newValue",
                    "desc": "",
                    "lua_type": "any"
                }
            ],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 155,
                "path": "src/Save.luau"
            }
        },
        {
            "name": "Subscribe",
            "desc": "",
            "params": [
                {
                    "name": "keyPath",
                    "desc": "",
                    "lua_type": "KeyPath"
                },
                {
                    "name": "listener",
                    "desc": "",
                    "lua_type": "(value: any) -> ()"
                },
                {
                    "name": "immediatelyCallListener",
                    "desc": "",
                    "lua_type": "boolean?"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "() -> ()"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 578,
                "path": "src/Save.luau"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "Save",
    "desc": "",
    "source": {
        "line": 20,
        "path": "src/Save.luau"
    }
}