Skip to main content

SettingsService

Provides a service for managing centralized player settings. See SettingsDataService for the data service.

Functions​

ObservePlayerSettingsBrio​

</>
SettingsService:ObservePlayerSettingsBrio(player: Player) → Observable<Brio<PlayerSettings>>

Observes the settings for a player using Brio.

ObservePlayerSettings​

</>
SettingsService:ObservePlayerSettings(player: Player) → Observable<PlayerSettings>

Observes the settings for a player.

GetPlayerSettings​

</>
SettingsService:GetPlayerSettings(player: Player) → PlayerSettings

Obtains the settings for a player.

PromisePlayerSettings​

</>
SettingsService:PromisePlayerSettings(
player: Player,
cancelToken: CancelToken?
) → Promise<PlayerSettings>

Promises the settings for a player.

Destroy​

</>
SettingsService:Destroy() → ()

Cleans up the settings service

Show raw api
{
    "functions": [
        {
            "name": "ObservePlayerSettingsBrio",
            "desc": "Observes the settings for a player using Brio.",
            "params": [
                {
                    "name": "player",
                    "desc": "",
                    "lua_type": "Player"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Observable<Brio<PlayerSettings>>"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 37,
                "path": "src/settings/src/Server/SettingsService.lua"
            }
        },
        {
            "name": "ObservePlayerSettings",
            "desc": "Observes the settings for a player.",
            "params": [
                {
                    "name": "player",
                    "desc": "",
                    "lua_type": "Player"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Observable<PlayerSettings>"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 49,
                "path": "src/settings/src/Server/SettingsService.lua"
            }
        },
        {
            "name": "GetPlayerSettings",
            "desc": "Obtains the settings for a player.",
            "params": [
                {
                    "name": "player",
                    "desc": "",
                    "lua_type": "Player"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "PlayerSettings"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 61,
                "path": "src/settings/src/Server/SettingsService.lua"
            }
        },
        {
            "name": "PromisePlayerSettings",
            "desc": "Promises the settings for a player.",
            "params": [
                {
                    "name": "player",
                    "desc": "",
                    "lua_type": "Player"
                },
                {
                    "name": "cancelToken",
                    "desc": "",
                    "lua_type": "CancelToken?"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Promise<PlayerSettings>"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 74,
                "path": "src/settings/src/Server/SettingsService.lua"
            }
        },
        {
            "name": "Destroy",
            "desc": "Cleans up the settings service",
            "params": [],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 83,
                "path": "src/settings/src/Server/SettingsService.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "SettingsService",
    "desc": "Provides a service for managing centralized player settings. See [SettingsDataService] for the data service.",
    "source": {
        "line": 6,
        "path": "src/settings/src/Server/SettingsService.lua"
    }
}