Skip to main content

PlayerSettingsBase

Base class for player settings.

Functions​

new​

</>
PlayerSettingsBase.new(
folder: Folder,
serviceBag: ServiceBag
) → PlayerSettingsBase

Base class for player settings

GetPlayer​

</>
PlayerSettingsBase:GetPlayer() → Player

Gets the player for this setting

GetFolder​

</>
PlayerSettingsBase:GetFolder() → Folder

Gets the settings folder

GetSettingProperty​

</>
PlayerSettingsBase:GetSettingProperty(
settingName: string,
defaultValue: any
) → SettingProperty

If you want to use a setting value object instead, this works... Otherwise consider using the setting definitions in a centralized location.

GetValue​

</>
PlayerSettingsBase:GetValue(
settingName: string,
defaultValue: any
) → any

Gets the setting value for the given name

SetValue​

</>
PlayerSettingsBase:SetValue(
settingName: string,
value: any
) → any

Sets the setting value for the given name

ObserveValue​

</>
PlayerSettingsBase:ObserveValue(
settingName: string,
defaultValue: any
) → Observable<any>

Sets the setting value for the given name

RestoreDefault​

</>
PlayerSettingsBase:RestoreDefault(
settingName: string,
defaultValue: T
) → ()

Restores the default value for the setting

EnsureInitialized​

</>
PlayerSettingsBase:EnsureInitialized(
settingName: string,
defaultValue: any
) → ()

Ensures the setting is initialized on the server or client

Show raw api
{
    "functions": [
        {
            "name": "new",
            "desc": "Base class for player settings",
            "params": [
                {
                    "name": "folder",
                    "desc": "",
                    "lua_type": "Folder"
                },
                {
                    "name": "serviceBag",
                    "desc": "",
                    "lua_type": "ServiceBag"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "PlayerSettingsBase"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 27,
                "path": "src/settings/src/Shared/Player/PlayerSettingsBase.lua"
            }
        },
        {
            "name": "GetPlayer",
            "desc": "Gets the player for this setting",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Player"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 39,
                "path": "src/settings/src/Shared/Player/PlayerSettingsBase.lua"
            }
        },
        {
            "name": "GetFolder",
            "desc": "Gets the settings folder",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Folder"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 47,
                "path": "src/settings/src/Shared/Player/PlayerSettingsBase.lua"
            }
        },
        {
            "name": "GetSettingProperty",
            "desc": "If you want to use a setting value object instead, this works... Otherwise\nconsider using the setting definitions in a centralized location.",
            "params": [
                {
                    "name": "settingName",
                    "desc": "",
                    "lua_type": "string"
                },
                {
                    "name": "defaultValue",
                    "desc": "",
                    "lua_type": "any"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "SettingProperty"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 59,
                "path": "src/settings/src/Shared/Player/PlayerSettingsBase.lua"
            }
        },
        {
            "name": "GetValue",
            "desc": "Gets the setting value for the given name",
            "params": [
                {
                    "name": "settingName",
                    "desc": "",
                    "lua_type": "string"
                },
                {
                    "name": "defaultValue",
                    "desc": "",
                    "lua_type": "any"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "any"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 75,
                "path": "src/settings/src/Shared/Player/PlayerSettingsBase.lua"
            }
        },
        {
            "name": "SetValue",
            "desc": "Sets the setting value for the given name",
            "params": [
                {
                    "name": "settingName",
                    "desc": "",
                    "lua_type": "string"
                },
                {
                    "name": "value",
                    "desc": "",
                    "lua_type": "any"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "any"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 99,
                "path": "src/settings/src/Shared/Player/PlayerSettingsBase.lua"
            }
        },
        {
            "name": "ObserveValue",
            "desc": "Sets the setting value for the given name",
            "params": [
                {
                    "name": "settingName",
                    "desc": "",
                    "lua_type": "string"
                },
                {
                    "name": "defaultValue",
                    "desc": "",
                    "lua_type": "any"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Observable<any>"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 115,
                "path": "src/settings/src/Shared/Player/PlayerSettingsBase.lua"
            }
        },
        {
            "name": "RestoreDefault",
            "desc": "Restores the default value for the setting",
            "params": [
                {
                    "name": "settingName",
                    "desc": "",
                    "lua_type": "string"
                },
                {
                    "name": "defaultValue",
                    "desc": "",
                    "lua_type": "T"
                }
            ],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 136,
                "path": "src/settings/src/Shared/Player/PlayerSettingsBase.lua"
            }
        },
        {
            "name": "EnsureInitialized",
            "desc": "Ensures the setting is initialized on the server or client",
            "params": [
                {
                    "name": "settingName",
                    "desc": "",
                    "lua_type": "string"
                },
                {
                    "name": "defaultValue",
                    "desc": "",
                    "lua_type": "any"
                }
            ],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 150,
                "path": "src/settings/src/Shared/Player/PlayerSettingsBase.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "PlayerSettingsBase",
    "desc": "Base class for player settings.",
    "source": {
        "line": 6,
        "path": "src/settings/src/Shared/Player/PlayerSettingsBase.lua"
    }
}