Reference API Roblox

Engine API

Website

Related

Reference API Roblox

UserSettings

A singleton object that houses basic user settings, which persist across all games on Roblox.

This class is not creatable. Instances of this class cannot be created with Instance.new.
Memory categoryInstances
Tags: [NotCreatable]

Member index 3

HistoryMember
462IsUserFeatureEnabled(name: string): bool
573Reset(): null
583SaveState(): null
inherited from ServiceProvider
497FindService(className: string): Instance
494GetService(className: string): Instance
553getService(className: string): Instance
553service(className: string): Instance
462Close()
462CloseLate()
462ServiceAdded(service: Instance)
462ServiceRemoving(service: Instance)
inherited from Instance
553Archivable: bool
635Capabilities: SecurityCapabilities
553Name: string
553Parent: Instance
635Sandboxed: bool
616UniqueId: UniqueId
576AddTag(tag: string): null
573ClearAllChildren(): null
462Clone(): Instance
573Destroy(): null
486FindFirstAncestor(name: string): Instance
486FindFirstAncestorOfClass(className: string): Instance
486FindFirstAncestorWhichIsA(className: string): Instance
486FindFirstChild(name: string, recursive: bool = false): Instance
486FindFirstChildOfClass(className: string): Instance
486FindFirstChildWhichIsA(className: string, recursive: bool = false): Instance
486FindFirstDescendant(name: string): Instance
563GetActor(): Actor
486GetAttribute(attribute: string): Variant
462GetAttributeChangedSignal(attribute: string): RBXScriptSignal
631GetAttributes(): Dictionary
648GetChildren(): Instances
462GetDebugId(scopeLength: int = 4): string
486GetDescendants(): Array
486GetFullName(): string
641GetStyled(name: string): Variant
576GetTags(): Array
576HasTag(tag: string): bool
486IsAncestorOf(descendant: Instance): bool
486IsDescendantOf(ancestor: Instance): bool
580IsPropertyModified(name: string): bool
573Remove(): null
576RemoveTag(tag: string): null
580ResetPropertyToDefault(name: string): null
573SetAttribute(attribute: string, value: Variant): null
462WaitForChild(childName: string, timeOut: double): Instance
648children(): Instances
553clone(): Instance
573destroy(): null
553findFirstChild(name: string, recursive: bool = false): Instance
648getChildren(): Instances
553isDescendantOf(ancestor: Instance): bool
573remove(): null
462AncestryChanged(child: Instance, parent: Instance)
462AttributeChanged(attribute: string)
462ChildAdded(child: Instance)
462ChildRemoved(child: Instance)
462DescendantAdded(descendant: Instance)
462DescendantRemoving(descendant: Instance)
500Destroying()
553childAdded(child: Instance)
inherited from Object
647ClassName: string
647className: string
647GetPropertyChangedSignal(property: string): RBXScriptSignal
647IsA(className: string): bool
650isA(className: string): bool
647Changed(property: string)

Description

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.

History 7

Members 3

IsUserFeatureEnabled

Parameters (1)
namestring
Returns (1)
bool

Returns true if the specified user feature is enabled. This will throw an error if the user feature does not exist.

This function checks against a list of FFlags, whose name starts with "User". The function is intended to be used by Roblox-created scripts, and functions similarly to GlobalSettings:GetFFlag().

Thread safetyUnsafe

History 2

Reset

Parameters (0)
No parameters.
Returns (1)
null

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.

Thread safetyUnsafe

History 3

SaveState

Parameters (0)
No parameters.
Returns (1)
null
SecurityRobloxScriptSecurity
Thread safetyUnsafe

History 1

Settings