Skip to main content

SettingProperty

Functions​

new​

</>
SettingProperty.new(
serviceBag: ServiceBag,
player: Player?,
definition: SettingDefinition
) → SettingProperty<T>

Constructs a new SettingProperty.

A nil player means the local player: the real Players.LocalPlayer, or the mock a test has already designated through PlayerMock.setMockedLocalPlayer. Designation may happen before bags boot -- matching production, where Players.LocalPlayer exists before any service runs -- so construction requires a resolvable local player up front.

Observe​

</>
SettingProperty.Observe(self: SettingProperty<T>) → Observable<T>

Observes the value of the setting property

SetValue​

</>
SettingProperty.SetValue(
self: SettingProperty<T>,
value: T
) → ()

Sets the value of the setting property. Will warn if it cannot do so.

TIP

Use [PromiseSetValue] to ensure value is set.

PromiseValue​

</>
SettingProperty.PromiseValue(self: SettingProperty<T>) → Promise<T>

Promises the value of the setting once it's loaded.

PromiseSetValue​

</>
SettingProperty.PromiseSetValue(
self: SettingProperty<T>,
value: T
) → Promise

Promises to set the value

RestoreDefault​

</>
SettingProperty.RestoreDefault(self: SettingProperty<T>) → ()

Restores the setting to the default value

PromiseRestoreDefault​

</>
SettingProperty.PromiseRestoreDefault(self: SettingProperty<T>) → Promise

Restores the setting to the default value. This is different than setting to the default value because it means there is no "user-set" value which could lead to values changing if defaults change.

Show raw api
{
    "functions": [
        {
            "name": "new",
            "desc": "Constructs a new SettingProperty.\n\nA nil player means the local player: the real `Players.LocalPlayer`, or the mock a test has\nalready designated through [PlayerMock.setMockedLocalPlayer]. Designation may happen before\nbags boot -- matching production, where `Players.LocalPlayer` exists before any service runs --\nso construction requires a resolvable local player up front.",
            "params": [
                {
                    "name": "serviceBag",
                    "desc": "",
                    "lua_type": "ServiceBag"
                },
                {
                    "name": "player",
                    "desc": "",
                    "lua_type": "Player?"
                },
                {
                    "name": "definition",
                    "desc": "",
                    "lua_type": "SettingDefinition"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "SettingProperty<T>"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 49,
                "path": "src/settings/src/Shared/Setting/SettingProperty.lua"
            }
        },
        {
            "name": "Observe",
            "desc": "Observes the value of the setting property",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "SettingProperty<T>"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Observable<T>"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 74,
                "path": "src/settings/src/Shared/Setting/SettingProperty.lua"
            }
        },
        {
            "name": "SetValue",
            "desc": "Sets the value of the setting property. Will warn if it cannot do so.\n\n:::tip\nUse [PromiseSetValue] to ensure value is set.\n:::",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "SettingProperty<T>"
                },
                {
                    "name": "value",
                    "desc": "",
                    "lua_type": "T"
                }
            ],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 158,
                "path": "src/settings/src/Shared/Setting/SettingProperty.lua"
            }
        },
        {
            "name": "PromiseValue",
            "desc": "Promises the value of the setting once it's loaded.",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "SettingProperty<T>"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Promise<T>"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 174,
                "path": "src/settings/src/Shared/Setting/SettingProperty.lua"
            }
        },
        {
            "name": "PromiseSetValue",
            "desc": "Promises to set the value",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "SettingProperty<T>"
                },
                {
                    "name": "value",
                    "desc": "",
                    "lua_type": "T"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Promise"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 186,
                "path": "src/settings/src/Shared/Setting/SettingProperty.lua"
            }
        },
        {
            "name": "RestoreDefault",
            "desc": "Restores the setting to the default value",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "SettingProperty<T>"
                }
            ],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 195,
                "path": "src/settings/src/Shared/Setting/SettingProperty.lua"
            }
        },
        {
            "name": "PromiseRestoreDefault",
            "desc": "Restores the setting to the default value. This is different than setting to the default value\nbecause it means there is no \"user-set\" value which could lead to values changing if\ndefaults change.",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "SettingProperty<T>"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Promise"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 213,
                "path": "src/settings/src/Shared/Setting/SettingProperty.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "SettingProperty",
    "desc": "",
    "source": {
        "line": 5,
        "path": "src/settings/src/Shared/Setting/SettingProperty.lua"
    }
}