UserSettings

Supported Class Other NotCreatable

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

2 Nova members · 1 modern Roblox members not implemented yet

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.

Inheritance

Object → Instance → ServiceProvider → GenericSettings → UserSettings

Nova inheritance: Instance → ServiceProvider → GenericSettings → UserSettings

Methods

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

UserSettings:IsUserFeatureEnabled(string name): 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 user features whose names start with "User". It is intended for Roblox-created scripts.

Roblox reference signature

UserSettings:IsUserFeatureEnabled(name: string): bool

Roblox documentation

Reset Supported Function Erases the saved state of the UserSettings, and restores its default values.

UserSettings:Reset()

Erases the saved state of the UserSettings, and restores its default values.

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.

Roblox reference signature

UserSettings:Reset(): null

Roblox documentation

Inherited members

Inherited from GenericSettings: 8 properties, 40 methods, 11 events. They are documented on the base class page.

1 modern Roblox member(s) are not implemented yet — expand to inspect

Members declared by Roblox's UserSettings class (or by a missing base class) that Nova does not expose. Use this list to scope a migration; the compatibility guide has the recommended workaround.

Methods

Member	Signature	Status	Notes	Flags
SaveState	UserSettings:SaveState(): null	Not yet	—	RobloxScriptSecurity

Roblox reference: UserSettings

Generated from Nova's API dump and Roblox creator-docs. Nova-only members come from the engine's reflection metadata.