Class
UserSettings
NotCreatable
A singleton object that houses basic user settings, which persist across all games on Roblox.
UserSettings is a singleton object that is used to house basic user settings,
which persist across all games. Currently, it only stores the
UserGameSettings object.
You can retrieve a reference to this object via the
UserSettings() function, which returns it.
Methods 2#
| IsUserFeatureEnabled | Returns true if the specified user feature is enabled. This will throw an error if the user feature does not exist. |
| Reset | Erases the saved state of the UserSettings, and restores its default values. |
IsUserFeatureEnabled(name: string): boolean#
Returns true if the specified user feature is enabled. This will throw an error if the user feature does not exist.
This function checks user features whose names start with "User". It is
intended for Roblox-created scripts.
| Name | Type | Default | Description |
|---|---|---|---|
name | string | The name of the user feature to check. Must begin with the User
prefix. |
Returns
boolean—trueif the named user feature exists and is enabled; otherwisefalse.
Reset(): ()#
Erases the saved state of the UserSettings, and restores its values back
to default. This function will fail to run correctly from a LocalScript,
as it does not have permission to restore all of the properties in the
UserGameSettings class.
Returns
()
Inherited members#
Inherited from Instance 58
Properties (10)
Archivable, archivable, Capabilities, IsInSandbox, Name, Parent, PredictionMode, RobloxLocked, Sandboxed, UniqueId
Methods (39)
AddTag, children, ClearAllChildren, Clone, clone, Destroy, destroy, FindFirstAncestor, FindFirstAncestorOfClass, FindFirstAncestorWhichIsA, FindFirstChild, findFirstChild, FindFirstChildOfClass, FindFirstChildWhichIsA, FindFirstDescendant, GetActor, GetAttribute, GetAttributeChangedSignal, GetAttributes, GetChildren, getChildren, GetDebugId, GetDescendants, GetFullName, GetStyled, GetStyledPropertyChangedSignal, GetTags, HasTag, IsAncestorOf, IsDescendantOf, isDescendantOf, IsPropertyModified, QueryDescendants, Remove, remove, RemoveTag, ResetPropertyToDefault, SetAttribute, WaitForChild