UserSettings
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.
Code Samples
A basic sample of how the IsUserFeatureEnabled function is used by Roblox to control certain features.
if UserSettings():IsUserFeatureEnabled("UserNoCameraClickToMove") then
print("'ClickToMove' should no longer be loaded from the CameraScript!")
else
print("'ClickToMove' is still loaded from the CameraScript!")
endA LocalScript that demonstrates how you can detect whether a game is in full screen or not.
local gameSettings = UserSettings().GameSettings
local function checkFullScreenMode()
local inFullscreen = gameSettings:InFullScreen()
if inFullscreen then
print("Full Screen mode enabled!")
else
print("Full Screen mode disabled!")
end
end
checkFullScreenMode()
gameSettings.FullscreenChanged:Connect(checkFullScreenMode)A basic example that shows how you can listen to changes in the user's settings. With this code pasted into a LocalScript running in the StarterPlayerScripts, you can change settings in Roblox's game menu, and see their values appear in the output as detected changes.
local gameSettings = UserSettings().GameSettings
local function onGameSettingChanged(nameOfSetting)
-- Fetch the value of this setting through a pcall to make sure we can retrieve it.
-- Sometimes the event fires with properties that LocalScripts can't access.
local canGetSetting, setting = pcall(function()
return gameSettings[nameOfSetting]
end)
if canGetSetting then
print("Your " .. nameOfSetting .. " has changed to: " .. tostring(setting))
end
end
gameSettings.Changed:Connect(onGameSettingChanged)Summary
Methods
Returns true if the specified user feature is enabled. This will throw an error if the user feature does not exist.
Erases the saved state of the UserSettings, and restores its default values.
Methods
Returns the service specified by the given className if it's already created, errors for an invalid name.
Returns the service with the requested class name, creating it if it does not exist.
Events
Events inherited from ServiceProviderEvents
Fires when the current place is exited.
Fired when a service is created.
Fired when a service is about to be removed.
Properties
Methods
IsUserFeatureEnabled
Parameters
Returns
Code Samples
if UserSettings():IsUserFeatureEnabled("UserNoCameraClickToMove") then
print("'ClickToMove' should no longer be loaded from the CameraScript!")
else
print("'ClickToMove' is still loaded from the CameraScript!")
end