API:Class/UserSettings

Client only:This object is client-side only! You should use a LocalScript instead of a Script when using it.
Filtered-inheritance mode: While this class technically inherits all Instance class members, some (if not all) have been hidden because they serve no purpose for this object.
Settings: This object has been marked as a settings object. It is used to hold persistent settings, which may be accessible by Roblox Studio's settings menu, or the in-game menu. This object cannot be created.

Configuration icon.pngUserSettings : Object Icon.pngGenericSettings : Object Icon.pngServiceProvider : Object Icon.pngInstance

A special client-only service provider, used to store certain singleton classes, such as the UserGameSettings This service can only be accessed by using the UserSettings() function, which returns it.

Functions

FunctionsmemberhiddenFunctions [toggle]

boolIsUserFeatureEnabled ( string name )

Returns the value of an FFlag, if the name of the flag starts with User. This function requires precise string arguments in order to be used, and will error if you use an invalid one.

|RMD member="API:Class/UserSettings/IsUserFeatureEnabled"|Returns the value of an FFlag, if the name of the flag starts with User.

This function requires precise string arguments in order to be used, and will error if you use an invalid one.|/RMD|

Returns the value of an FFlag, if the name of the flag starts with User. This function requires precise string arguments in order to be used, and will error if you use an invalid one.
Inherited from Object Icon.pngServiceProvider:
Ref<Instance>FindService ( string className )

Returns the service specified by the given className if it's already created, errors for an invalid name.

|RMD member="API:Class/ServiceProvider/FindService"|Returns the service specified by the given className if it's already created, errors for an invalid name.|/RMD|
Ref<Instance>GetService ( string className )

Returns the service with the requested class name, creating it if it does not exist.

|RMD member="API:Class/ServiceProvider/GetService"|Returns the service with the requested class name, creating it if it does not exist.|/RMD|
InstancegetService ( string className ) [deprecated]

Deprecated in favor of GetService.

|RMD member="API:Class/ServiceProvider/getService"|Deprecated in favor of GetService.|/RMD|
Instanceservice ( string className ) [deprecated]

Deprecated in favor of GetService.

|RMD member="API:Class/ServiceProvider/service"|Deprecated in favor of GetService.|/RMD|
FindService ( string className )
Returns the service specified by the given className if it's already created, errors for an invalid name.
GetService ( string className )
Returns the service with the requested class name, creating it if it does not exist.
getService ( string className ) [deprecated]
Deprecated in favor of GetService.
service ( string className ) [deprecated]
Deprecated in favor of GetService.


Events

EventsmemberhiddenEvents [toggle]

Inherited from Object Icon.pngServiceProvider:
Close ( )

Fires when the current place is exited.

|RMD member="API:Class/ServiceProvider/Close"|Fires when the current place is exited.|/RMD|
ServiceAdded ( Instance service )

Fired when a service is created.

|RMD member="API:Class/ServiceProvider/ServiceAdded"|Fired when a service is created.|/RMD|
ServiceRemoving ( Instance service )

Fired when a service is about to be removed.

|RMD member="API:Class/ServiceProvider/ServiceRemoving"|Fired when a service is about to be removed.|/RMD|
CloseLate ( ) [LocalUserSecurity]

Fired immediately after the Close signal is fired.

|RMD member="API:Class/ServiceProvider/CloseLate"|Fired immediately after the Close signal is fired.|/RMD|
Close ( )
Fires when the current place is exited.
Fired when a service is created.
Fired when a service is about to be removed.
CloseLate ( ) [LocalUserSecurity]
Fired immediately after the Close signal is fired.

|RMD member="API:Class/UserSettings"|A special client-only service provider, used to store certain singleton classes, such as the UserGameSettings This service can only be accessed by using the UserSettings() function, which returns it. |/RMD|