UserGameSettings is a singleton class found inside of the UserSettings singleton. It holds various persistent settings relating to how the user wants to control their camera, and their character.- Memory category
- Instances
- Own members
- 90
- Inherited members
- 75
- Subclasses
- 0
- Siblings
- 608
Properties99
Property categoryBehavior
- Determines if an
Instanceand its descendants can be cloned usingInstance:Clone(), and can be saved/published. - Deprecated: This deprecated property is a variant of
Instance.Archivablewhich should be used instead.Use Archivable instead.
Property categoryData
Property categoryPermissions
- The set of capabilities allowed to be used for scripts inside this container.
- Indicates whether the instance is inside a sandboxed container.
- When enabled, the instance can only access abilities in its
Capabilitieslist.
Defined byUserGameSettings76
Property categoryAppearance
UserGameSettings.GraphicsOptimizationMode: Enum.GraphicsOptimizationMode The graphics optimization mode used by the client to balance visual quality and performance.UserGameSettings.GraphicsQualityLevel: number The current graphics quality level being used by the client.UserGameSettings.MaxQualityEnabled: boolean Indicates whether the client's graphics quality is set to the maximum available level.UserGameSettings.SavedQualityLevel: Enum.SavedQualitySetting The graphics quality level set by the client.
Property categoryConfiguration
UserGameSettings.gaID: string
Property categoryControl
UserGameSettings.CameraMode: Enum.CustomCameraMode The custom camera mode currently in-use by the client.UserGameSettings.ComputerCameraMovementMode: Enum.ComputerCameraMovementMode The camera movement mode currently in-use by the client on desktop.UserGameSettings.ComputerMovementMode: Enum.ComputerMovementMode The type of controls being used by the client on desktop.UserGameSettings.ControlMode: Enum.ControlMode Toggles whether or not the client can use the Mouse Lock Switch mode.UserGameSettings.HapticStrength: number UserGameSettings.RotationType: Enum.RotationType Controls how the client's character is rotated.UserGameSettings.TouchCameraMovementMode: Enum.TouchCameraMovementMode The camera type in-use by the client while on a mobile device.UserGameSettings.TouchMovementMode: Enum.TouchMovementMode The type of controls being used by the client on a mobile device.UserGameSettings.VRComfortSetting: Enum.VRComfortSetting UserGameSettings.VRSafetyBubbleMode: Enum.VRSafetyBubbleMode
Property categoryData
UserGameSettings.AllTutorialsDisabled: boolean Indicates whether all in-game tutorials have been disabled by the user.UserGameSettings.BadgeVisible: boolean Indicates whether badge notifications are visible to the client.UserGameSettings.CameraYInverted: boolean UserGameSettings.ChatTranslationEnabled: boolean UserGameSettings.ChatTranslationFTUXShown: boolean UserGameSettings.ChatTranslationLocale: string UserGameSettings.ChatTranslationToggleEnabled: boolean UserGameSettings.ChatVisible: boolean Indicates whether the in-game chat is visible to the client.UserGameSettings.CompletedTutorials: string UserGameSettings.ComputerCameraMovementChanged: boolean UserGameSettings.ComputerMovementChanged: boolean UserGameSettings.DefaultCameraID: string UserGameSettings.FramerateCap: number UserGameSettings.Fullscreen: boolean Indicates whether the client's window is currently in full screen mode.UserGameSettings.GamepadCameraSensitivity: number Describes how sensitive the camera is when using a gamepad.UserGameSettings.HasEverUsedVR: boolean Indicates whether the user has ever launched the client in VR mode.UserGameSettings.IsUsingCameraYInverted: boolean UserGameSettings.IsUsingGamepadCameraSensitivity: boolean UserGameSettings.MasterVolume: number A float between 0 and 1 representing the volume of the game's client.UserGameSettings.MasterVolumeStudio: number A float between 0 and 1 representing the master volume used in Roblox Studio.UserGameSettings.MicroProfilerWebServerEnabled: boolean UserGameSettings.MicroProfilerWebServerIP: string UserGameSettings.MicroProfilerWebServerPort: number UserGameSettings.MouseSensitivity: number A float between 0 and 4 representing the sensitivity of the client's camera sensitivity.UserGameSettings.MouseSensitivityFirstPerson: Vector2 UserGameSettings.MouseSensitivityThirdPerson: Vector2 UserGameSettings.OnboardingsCompleted: string A comma-separated list of onboarding IDs that the user has completed.UserGameSettings.OnScreenProfilerEnabled: boolean UserGameSettings.PartyVoiceVolume: number A float between 0 and 1 representing the volume of party voice chat.UserGameSettings.PeoplePageLayout: Enum.PeoplePageLayout The layout style used to display the people page in the in-game menu.UserGameSettings.PerformanceStatsVisible: boolean UserGameSettings.PlayerHeight: number UserGameSettings.PlayerListVisible: boolean Indicates whether the in-game player list is visible to the client.UserGameSettings.PlayerNamesEnabled: boolean Indicates whether player names are displayed above characters in the game.UserGameSettings.PreferredTextSize: Enum.PreferredTextSize UserGameSettings.PreferredTransparency: number UserGameSettings.QualityResetLevel: number UserGameSettings.RCCProfilerRecordFrameRate: number Internal MicroProfiler setting specifying the frame rate used when capturing server-side RCC profiler data.UserGameSettings.RCCProfilerRecordTimeFrame: number Internal MicroProfiler setting specifying the duration over which server-side RCC profiler data is captured.UserGameSettings.ReadAloud: boolean UserGameSettings.ReducedMotion: boolean UserGameSettings.StartMaximized: boolean Indicates whether Roblox Studio should launch in a maximized window.UserGameSettings.StartScreenPosition: Vector2 The screen position of the client's window when the application launches.UserGameSettings.StartScreenSize: Vector2 The size of the client's window when the application launches.UserGameSettings.StudioPreferredTextSize: Enum.PreferredTextSize UserGameSettings.TouchCameraMovementChanged: boolean UserGameSettings.TouchMovementChanged: boolean UserGameSettings.UIScaleMultiplierHundredths: number UserGameSettings.UsedCoreGuiIsVisibleToggle: boolean Indicates whether the user has toggled the visibility of core GUI elements.UserGameSettings.UsedCustomGuiIsVisibleToggle: boolean Indicates whether the user has toggled the visibility of custom GUI elements.UserGameSettings.UsedHideHudShortcut: boolean Indicates whether the user has used the keyboard shortcut for hiding the HUD.UserGameSettings.VignetteEnabled: boolean Indicates whether the VR vignette comfort effect is enabled.UserGameSettings.VignetteEnabledCustomOption: boolean UserGameSettings.VoiceChatVolume: number A float between0and2representing the volume of in-game voice chat.UserGameSettings.VREnabled: boolean Indicates whether the client is currently running in VR mode.UserGameSettings.VRRotationIntensity: number The intensity of camera rotation when turning in VR.UserGameSettings.VRSmoothRotationEnabled: boolean Indicates whether smooth rotation is used instead of snap rotation in VR.UserGameSettings.VRSmoothRotationEnabledCustomOption: boolean UserGameSettings.VRThirdPersonFollowCamEnabled: boolean UserGameSettings.VRThirdPersonFollowCamEnabledCustomOption: boolean
No properties match the filters.
Methods53
Object:GetPropertyChangedSignal( property: string): RBXScriptSignal Get an event that fires when a given property of the object changes.Parameters Parameter Description property: stringThe property to connect to.Returns Type Description RBXScriptSignalA signal that fires whenever the property changes.- Returns true if an object's class matches or inherits from a given class.
Parameters Parameter Description className: stringThe class against which the Object's class will be checked. Case-sensitive.Returns Type Description booleanDescribes whether the Object's class matched or is a subclass of the given class. - Deprecated: This deprecated function is a variant of
Object:IsA()which should be used instead.Parameters Parameter className: stringReturns Type booleanUse IsA instead.
- Applies a tag to the instance.
Parameters Parameter Description tag: stringThe tag to apply to the instance. - This method destroys all of an instance's children.
- Create a copy of an instance and all its descendants, ignoring instances that are not
Archivable.Returns Type Description InstanceA copy of the instance, ornilif the instance is notArchivable. - Sets the
Instance.Parentproperty tonil, locks theInstance.Parentproperty, disconnects all connections, and callsDestroy()on all children. Instance:FindFirstAncestor( name: string): Instance Returns the first ancestor of theInstancewhoseInstance.Nameis equal to the given name.Parameters Parameter Description name: stringTheInstance.Nameto be looked for.Instance:FindFirstAncestorOfClass( className: string): Instance Returns the first ancestor of theInstancewhoseObject.ClassNameis equal to the given className.Parameters Parameter Description className: stringTheObject.ClassNameto be looked for.Instance:FindFirstAncestorWhichIsA( className: string): Instance Returns the first ancestor of theInstancefor whomObject:IsA()returns true for the given className.Parameters Parameter Description className: stringTheObject.ClassNameto be looked for.Instance:FindFirstChild( name: string, recursive: boolean? = false): Instance Returns the first child of theInstancefound with the given name.Parameters Parameter Description name: stringTheInstance.Nameto be searched for.recursive: boolean? = falseWhether or not the search should be conducted recursively.Instance:FindFirstChildOfClass( className: string): Instance Parameters Parameter Description className: stringTheObject.ClassNameto be looked for.Instance:FindFirstChildWhichIsA(className: string,recursive: boolean? = false,): Instance Returns the first child of theInstancefor whomObject:IsA()returns true for the given className.Parameters Parameter Description className: stringTheObject.ClassNameto be searched for.recursive: boolean? = falseWhether or not the search should be conducted recursively.Instance:FindFirstDescendant( name: string): Instance Returns the first descendant found with the givenInstance.Name.Parameters Parameter Description name: stringTheInstance.Nameto search for.- Returns the
Actorassociated with the Instance, if any. Instance:GetAttribute( attribute: string): any Returns the value which has been assigned to the given attribute name.Parameters Parameter Description attribute: stringThe name of the attribute being retrieved.Returns Type Description anyThe value which has been assigned to the given attribute name. If no attribute has been assigned,nilis returned.Instance:GetAttributeChangedSignal( attribute: string): RBXScriptSignal Returns an event that fires when the given attribute changes.Parameters Parameter Description attribute: stringThe name of the specified attribute for which the change signal is being returned.Returns Type Description RBXScriptSignalAn event that fires when the given attribute changes.- Returns a dictionary of the instance's attributes.
Returns Type Description { [string]: any }A dictionary of string → variant pairs for each attribute where the string is the name of the attribute and the variant is a non-nil value. - Returns an array containing all of the instance's children.
Returns Type Description { Instance }An array containing the instance's children. Instance:GetDebugId( scopeLength: number? = 4): string Returns a coded string of the debug ID used internally by Roblox.Parameters Parameter Description scopeLength: number? = 4The scope length.Returns Type Description stringThe Debug ID string.- Returns an array containing all of the descendants of the instance.
Returns Type Description { Instance }An array containing the instance's descendants. - Returns a string describing the instance's ancestry.
- Returns the styled or explicitly modified value of the specified property, or else the default property value if it hasn't been styled/modified.
Parameters Parameter Description name: stringName of the property to query.selector: string?Optional selector for the pseudo instance you are targeting on the instance.Returns Type Description anyThe styled or explicitly modified value of the specified property, or else the default property value if it hasn't been styled/modified. Instance:GetStyledPropertyChangedSignal( property: string): RBXScriptSignal Returns an event that fires when the given style property changes on the instance.Parameters Parameter Description property: stringName of the style property for which to listen for changes.Returns Type Description RBXScriptSignalEvent that fires when the given style property changes.- Gets an array of all tags applied to the instance.
Returns Type Description { any }An array of strings, each representing a tag applied to the instance. - Check whether the instance has a given tag.
Parameters Parameter Description tag: stringThe tag to check for on the instance.Returns Type Description booleantrueif the instance has the given tag,falseotherwise. Instance:IsAncestorOf( descendant: Instance): boolean Returns true if anInstanceis an ancestor of the given descendant.Instance:IsDescendantOf( ancestor: Instance): boolean Returnstrueif anInstanceis a descendant of the given ancestor.Instance:IsPropertyModified( property: string): boolean Returnstrueif the value stored in the specified property is not equal to the code-instantiated default.Parameters Parameter Description property: stringName of the property to query.Returns Type Description booleanBoolean indicating whether the property is modified from its code‑instantiated default.Instance:QueryDescendants( selector: string): { Instance } Returns an array containing all descendants of the instance that match theselectorstring.Parameters Parameter Description selector: stringSelector string used to filter elements.Returns Type Description { Instance }An array of instances (empty if nothing matched the selector).- Removes a tag from the instance.
Parameters Parameter Description tag: stringThe tag to remove from the instance. Instance:ResetPropertyToDefault( property: string) Resets a property to its default value.Parameters Parameter Description property: stringName of the property to reset.Instance:SetAttribute( attribute: string, value: any) Sets the attribute with the given name to the given value.Instance:WaitForChild( childName: string, timeOut: number): Instance Returns the child of theInstancewith the given name. If the child does not exist, it will yield the current thread until it does.Parameters Parameter Description childName: stringTheInstance.Nameto be looked for.timeOut: numberAn optional time out parameter.- Deprecated: This item is deprecated in favor of
Instance:Destroy()andInstance:ClearAllChildren(). If you must remove an object from the game, and wish to use the object later, set itsParentproperty tonilinstead of using this method.
Sets the object'sParenttonil, and does the same for all its descendants. - Deprecated: This item has been superseded by
Instance:GetChildren()which should be used in all new work.
Returns an array of the object's children.Returns Type Description { Instance }Array of child objects/instances.Use GetChildren instead.
- Deprecated: This deprecated function is a variant of
Instance:Clone()which should be used instead.Returns Type InstanceUse Clone instead.
- Deprecated: This deprecated function is a variant of
Instance:Destroy()which should be used instead.Use Destroy instead.
Instance:findFirstChild( name: string, recursive: boolean? = false): Instance Deprecated: This deprecated function is a variant ofInstance:FindFirstChild()which should be used instead.Returns Type InstanceUse FindFirstChild instead.
- Deprecated: This deprecated function is a variant of
Instance:GetChildren()which should be used instead.Returns Type { Instance }Use GetChildren instead.
Instance:isDescendantOf( ancestor: Instance): boolean Deprecated: This deprecated function is a variant ofInstance:IsDescendantOf()which should be used instead.Parameters Parameter ancestor: InstanceReturns Type booleanUse IsDescendantOf instead.
- Deprecated: This deprecated function is a variant of
Instance:Remove()which has also been deprecated. Neither function should be used in new work.Use Remove instead.
Defined byUserGameSettings11
UserGameSettings:GetCameraYInvertValue( ): number Returns the camera's Y-invert value.Returns Type Description numberThe camera's current Y-axis inversion multiplier.UserGameSettings:GetDefaultFramerateCap( ): number Returns Type number- Checks if onboarding has been completed.
Parameters Parameter Description onboardingId: stringThe onboarding ID to inquire about.Returns Type Description booleanWhether or not the onboarding in particular has been completed yet. Parameters Parameter tutorialId: stringReturns Type booleanUserGameSettings:InFullScreen( ): boolean Returns true if the user's Roblox window is in full screen mode.Returns Type Description booleanWhether the user's Roblox window is in full screen mode.UserGameSettings:InStudioMode( ): boolean Returns true if the client's game session is in Roblox Studio.Returns Type Description booleanWhether the current client session is running in Roblox Studio.UserGameSettings:ResetOnboardingCompleted( onboardingId: string) Parameters Parameter onboardingId: string- If called, Roblox toggles the menu option to invert the user's camera y axis.
- If called, Roblox toggles the menu option to control the camera sensitivity with gamepads.
UserGameSettings:SetOnboardingCompleted( onboardingId: string) Sets onboarding as completed.Parameters Parameter Description onboardingId: stringThe onboarding ID to set as completed.
No methods match the filters.
Events13
Object.Changed: RBXScriptSignal<( property: string)> Fires immediately after a property of the object changes, with some limitations.Parameters Parameter property: string
Instance.AncestryChanged: RBXScriptSignal<( child: Instance, parent: Instance)> Fires when theInstance.Parentproperty of this object or one of its ancestors is changed.Instance.AttributeChanged: RBXScriptSignal<( attribute: string)> Fires whenever an attribute is changed on theInstance.Parameters Parameter attribute: stringInstance.ChildAdded: RBXScriptSignal<( child: Instance)> Fires after an object is parented to thisInstance.Parameters Parameter child: InstanceInstance.ChildRemoved: RBXScriptSignal<( child: Instance)> Fires after a child is removed from thisInstance.Parameters Parameter child: InstanceInstance.DescendantAdded: RBXScriptSignal<( descendant: Instance)> Fires after a descendant is added to theInstance.Parameters Parameter descendant: InstanceInstance.DescendantRemoving: RBXScriptSignal<( descendant: Instance)> Fires immediately before a descendant of theInstanceis removed.Parameters Parameter descendant: Instance- Fires immediately before (or is deferred until after) the instance is destroyed via
Instance:Destroy(). - Fires whenever any style property is changed on the instance, including when a property is set to
nil. Instance.childAdded: RBXScriptSignal<( child: Instance)> Deprecated: This deprecated event is a variant ofInstance.ChildAddedwhich should be used instead.Parameters Parameter child: InstanceUse ChildAdded instead.
Defined byUserGameSettings3
UserGameSettings.FullscreenChanged: RBXScriptSignal<( isFullscreen: boolean)> Fires if the user's full screen mode is changed.Parameters Parameter isFullscreen: booleanUserGameSettings.PerformanceStatsVisibleChanged: RBXScriptSignal<( isPerformanceStatsVisible: boolean)> Parameters Parameter isPerformanceStatsVisible: booleanUserGameSettings.StudioModeChanged: RBXScriptSignal<( isStudioMode: boolean)> Fired when the user's client switches between Studio mode and in-game mode. This gets fired periodically in Roblox Studio when a session starts.Parameters Parameter isStudioMode: boolean
No events match the filters.