16 min read

Source: Roblox Creator Hub · CC BY 4.0 · View source · Code samples: MIT Imported 2026-10-03. Formatting adapted for this site.

UserGameSettings

Inherits from: Instance → Object

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.

The properties on this class reflect both the user-facing options exposed in the in-game settings menu (such as graphics quality, master volume, camera and control modes) as well as other contextual user-configurable state that is not surfaced in the menu itself (such as internal onboarding progress, VR comfort options, window layout, and debug or profiling configuration). As a result, some properties listed here may not correspond to anything visible in the settings UI, and many are restricted to internal Roblox scripts.

You can access this object from a LocalScript via:

UserSettings():GetService("UserGameSettings")

This object is intended to be used on the client only, as it serves no purpose on the server. It will also reflect your own settings when testing in Roblox Studio.

Inherits from: Instance

Memory category: Instances

Tags: NotCreatable, Service, NotReplicated

Code samples: View on Creator Hub (UserGameSettings-Listener).

Properties

NameType / ReturnsDescription
UserGameSettings.AllTutorialsDisabledbooleanIndicates whether all in-game tutorials have been disabled by the user.
UserGameSettings.BadgeVisiblebooleanIndicates whether badge notifications are visible to the client.
UserGameSettings.CameraModeCustomCameraModeThe custom camera mode currently in-use by the client.
UserGameSettings.ChatVisiblebooleanIndicates whether the in-game chat is visible to the client.
UserGameSettings.ComputerCameraMovementModeComputerCameraMovementModeThe camera movement mode currently in-use by the client on desktop.
UserGameSettings.ComputerMovementModeComputerMovementModeThe type of controls being used by the client on desktop.
UserGameSettings.ControlModeControlModeToggles whether or not the client can use the Mouse Lock Switch mode.
UserGameSettings.FullscreenbooleanIndicates whether the client's window is currently in full screen mode.
UserGameSettings.GamepadCameraSensitivityfloatDescribes how sensitive the camera is when using a gamepad.
UserGameSettings.GraphicsOptimizationModeGraphicsOptimizationModeThe graphics optimization mode used by the client to balance visual quality and performance.
UserGameSettings.GraphicsQualityLevelintThe current graphics quality level being used by the client.
UserGameSettings.HasEverUsedVRbooleanIndicates whether the user has ever launched the client in VR mode.
UserGameSettings.MasterVolumefloatA float between 0 and 1 representing the volume of the game's client.
UserGameSettings.MasterVolumeStudiofloatA float between 0 and 1 representing the master volume used in Roblox Studio.
UserGameSettings.MaxQualityEnabledbooleanIndicates whether the client's graphics quality is set to the maximum available level.
UserGameSettings.MouseSensitivityfloatA float between 0 and 4 representing the sensitivity of the client's camera sensitivity.
UserGameSettings.OnboardingsCompletedstringA comma-separated list of onboarding IDs that the user has completed.
UserGameSettings.PartyVoiceVolumefloatA float between 0 and 1 representing the volume of party voice chat.
UserGameSettings.PeoplePageLayoutPeoplePageLayoutThe layout style used to display the people page in the in-game menu.
UserGameSettings.PlayerListVisiblebooleanIndicates whether the in-game player list is visible to the client.
UserGameSettings.PlayerNamesEnabledbooleanIndicates whether player names are displayed above characters in the game.
UserGameSettings.RCCProfilerRecordFrameRateintInternal MicroProfiler setting specifying the frame rate used when capturing server-side RCC profiler data.
UserGameSettings.RCCProfilerRecordTimeFrameintInternal MicroProfiler setting specifying the duration over which server-side RCC profiler data is captured.
UserGameSettings.RotationTypeRotationTypeControls how the client's character is rotated.
UserGameSettings.SavedQualityLevelSavedQualitySettingThe graphics quality level set by the client.
UserGameSettings.StartMaximizedbooleanIndicates whether Roblox Studio should launch in a maximized window.
UserGameSettings.StartScreenPositionVector2The screen position of the client's window when the application launches.
UserGameSettings.StartScreenSizeVector2The size of the client's window when the application launches.
UserGameSettings.TouchCameraMovementModeTouchCameraMovementModeThe camera type in-use by the client while on a mobile device.
UserGameSettings.TouchMovementModeTouchMovementModeThe type of controls being used by the client on a mobile device.
UserGameSettings.UsedCoreGuiIsVisibleTogglebooleanIndicates whether the user has toggled the visibility of core GUI elements.
UserGameSettings.UsedCustomGuiIsVisibleTogglebooleanIndicates whether the user has toggled the visibility of custom GUI elements.
UserGameSettings.UsedHideHudShortcutbooleanIndicates whether the user has used the keyboard shortcut for hiding the HUD.
UserGameSettings.VignetteEnabledbooleanIndicates whether the VR vignette comfort effect is enabled.
UserGameSettings.VoiceChatVolumefloatA float between 0 and 2 representing the volume of in-game voice chat.
UserGameSettings.VREnabledbooleanIndicates whether the client is currently running in VR mode.
UserGameSettings.VRRotationIntensityintThe intensity of camera rotation when turning in VR.
UserGameSettings.VRSmoothRotationEnabledbooleanIndicates whether smooth rotation is used instead of snap rotation in VR.

Inherited from Instance

NameType / ReturnsDescription
Instance.ArchivablebooleanDetermines if an Instance and its descendants can be cloned using Instance:Clone(), and can be saved/published.
Instance.archivableboolean
Instance.CapabilitiesSecurityCapabilitiesThe set of capabilities allowed to be used for scripts inside this container.
Instance.IsInSandboxbooleanIndicates whether the instance is inside a sandboxed container.
Instance.NamestringA non-unique identifier of the Instance.
Instance.ParentInstanceDetermines the hierarchical parent of the Instance.
Instance.PredictionModePredictionModeReflects the client-side prediction mode applied to the instance under server-authoritative physics.
Instance.RobloxLockedbooleanA deprecated property that used to protect CoreGui objects.
Instance.SandboxedbooleanWhen enabled, the instance can only access abilities in its Capabilities list.
Instance.UniqueIdUniqueIdA unique identifier for the instance.

Inherited from Object

NameType / ReturnsDescription
Object.ClassNamestringA read-only string representing the class this Object belongs to.
Object.classNamestring

UserGameSettings.AllTutorialsDisabled

Indicates whether all in-game tutorials have been disabled by the user.

FieldValue
typeboolean
security{"read":"RobloxScriptSecurity","write":"RobloxScriptSecurity"}
thread safetyReadSafe
categoryData
serialization{"can_load":true,"can_save":true}

UserGameSettings.BadgeVisible

Indicates whether badge notifications are visible to the client.

FieldValue
typeboolean
security{"read":"RobloxScriptSecurity","write":"RobloxScriptSecurity"}
thread safetyReadSafe
categoryData
serialization{"can_load":true,"can_save":true}

UserGameSettings.CameraMode

The custom camera mode currently in-use by the client.

FieldValue
typeCustomCameraMode
security{"read":"RobloxScriptSecurity","write":"RobloxScriptSecurity"}
thread safetyReadSafe
categoryControl
serialization{"can_load":true,"can_save":true}

UserGameSettings.ChatVisible

Indicates whether the in-game chat is visible to the client.

FieldValue
typeboolean
security{"read":"RobloxScriptSecurity","write":"RobloxScriptSecurity"}
thread safetyReadSafe
categoryData
serialization{"can_load":true,"can_save":true}

UserGameSettings.ComputerCameraMovementMode

The camera movement mode currently in-use by the client on desktop.

FieldValue
typeComputerCameraMovementMode
security{"read":"None","write":"None"}
thread safetyReadSafe
categoryControl
serialization{"can_load":true,"can_save":true}
capabilities["Input"]

UserGameSettings.ComputerMovementMode

The type of controls being used by the client on desktop.

FieldValue
typeComputerMovementMode
security{"read":"None","write":"None"}
thread safetyReadSafe
categoryControl
serialization{"can_load":true,"can_save":true}
capabilities["Input"]

UserGameSettings.ControlMode

Deprecated. This property has been deprecated. You can enable mouse-locked third-person control, or "Shift Lock Mode", through the MouseBehavior in PlayerScripts:RegisterTouchCameraMovementMode() and PlayerScripts:RegisterComputerCameraMovementMode().

Toggles whether or not the client can use the Mouse Lock Switch mode.

FieldValue
typeControlMode
security{"read":"None","write":"None"}
thread safetyReadSafe
categoryControl
serialization{"can_load":true,"can_save":true}
capabilities["Input"]

UserGameSettings.Fullscreen

Indicates whether the client's window is currently in full screen mode.

FieldValue
typeboolean
security{"read":"RobloxScriptSecurity","write":"RobloxScriptSecurity"}
thread safetyReadSafe
categoryData
serialization{"can_load":true,"can_save":true}

UserGameSettings.GamepadCameraSensitivity

Describes how sensitive the camera is when using a gamepad.

FieldValue
typefloat
security{"read":"None","write":"None"}
thread safetyReadSafe
categoryData
serialization{"can_load":true,"can_save":true}
capabilities["Input"]

UserGameSettings.GraphicsOptimizationMode

The graphics optimization mode used by the client to balance visual quality and performance.

FieldValue
typeGraphicsOptimizationMode
security{"read":"RobloxScriptSecurity","write":"RobloxScriptSecurity"}
thread safetyReadSafe
categoryAppearance
serialization{"can_load":true,"can_save":true}

UserGameSettings.GraphicsQualityLevel

The current graphics quality level being used by the client.

FieldValue
typeint
security{"read":"RobloxScriptSecurity","write":"RobloxScriptSecurity"}
thread safetyReadSafe
categoryAppearance
serialization{"can_load":true,"can_save":true}

UserGameSettings.HasEverUsedVR

Indicates whether the user has ever launched the client in VR mode.

FieldValue
typeboolean
security{"read":"RobloxScriptSecurity","write":"RobloxScriptSecurity"}
thread safetyReadSafe
categoryData
serialization{"can_load":true,"can_save":true}

UserGameSettings.MasterVolume

A float between 0 and 1 representing the volume of the game's client.

FieldValue
typefloat
security{"read":"RobloxScriptSecurity","write":"RobloxScriptSecurity"}
thread safetyReadSafe
categoryData
serialization{"can_load":true,"can_save":true}

UserGameSettings.MasterVolumeStudio

A float between 0 and 1 representing the master volume used in Roblox Studio.

FieldValue
typefloat
security{"read":"RobloxScriptSecurity","write":"RobloxScriptSecurity"}
thread safetyReadSafe
categoryData
serialization{"can_load":true,"can_save":true}

UserGameSettings.MaxQualityEnabled

Indicates whether the client's graphics quality is set to the maximum available level.

FieldValue
typeboolean
security{"read":"RobloxScriptSecurity","write":"RobloxScriptSecurity"}
thread safetyReadSafe
categoryAppearance
serialization{"can_load":true,"can_save":true}

UserGameSettings.MouseSensitivity

A float between 0 and 4 representing the sensitivity of the client's camera sensitivity.

FieldValue
typefloat
security{"read":"None","write":"None"}
thread safetyReadSafe
categoryData
serialization{"can_load":true,"can_save":true}
capabilities["Input"]

UserGameSettings.OnboardingsCompleted

A comma-separated list of onboarding IDs that the user has completed.

FieldValue
typestring
security{"read":"RobloxScriptSecurity","write":"RobloxScriptSecurity"}
thread safetyReadSafe
categoryData
serialization{"can_load":false,"can_save":false}

UserGameSettings.PartyVoiceVolume

A float between 0 and 1 representing the volume of party voice chat.

FieldValue
typefloat
security{"read":"RobloxScriptSecurity","write":"RobloxScriptSecurity"}
thread safetyReadSafe
categoryData
serialization{"can_load":true,"can_save":true}

UserGameSettings.PeoplePageLayout

The layout style used to display the people page in the in-game menu.

FieldValue
typePeoplePageLayout
security{"read":"RobloxScriptSecurity","write":"RobloxScriptSecurity"}
thread safetyReadSafe
categoryData
serialization{"can_load":true,"can_save":true}

UserGameSettings.PlayerListVisible

Indicates whether the in-game player list is visible to the client.

FieldValue
typeboolean
security{"read":"RobloxScriptSecurity","write":"RobloxScriptSecurity"}
thread safetyReadSafe
categoryData
serialization{"can_load":true,"can_save":true}

UserGameSettings.PlayerNamesEnabled

Indicates whether player names are displayed above characters in the game.

FieldValue
typeboolean
security{"read":"RobloxScriptSecurity","write":"RobloxScriptSecurity"}
thread safetyReadSafe
categoryData
serialization{"can_load":true,"can_save":true}

UserGameSettings.RCCProfilerRecordFrameRate

Internal MicroProfiler setting specifying the frame rate used when capturing server-side RCC profiler data.

FieldValue
typeint
security{"read":"None","write":"None"}
thread safetyReadSafe
categoryData
serialization{"can_load":true,"can_save":true}

UserGameSettings.RCCProfilerRecordTimeFrame

Internal MicroProfiler setting specifying the duration over which server-side RCC profiler data is captured.

FieldValue
typeint
security{"read":"None","write":"None"}
thread safetyReadSafe
categoryData
serialization{"can_load":true,"can_save":true}

UserGameSettings.RotationType

Controls how the client's character is rotated.

FieldValue
typeRotationType
security{"read":"None","write":"None"}
thread safetyReadSafe
categoryControl
serialization{"can_load":false,"can_save":false}
capabilities["Input"]

UserGameSettings.SavedQualityLevel

The graphics quality level set by the client.

FieldValue
typeSavedQualitySetting
security{"read":"None","write":"None"}
thread safetyReadSafe
categoryAppearance
serialization{"can_load":true,"can_save":true}
capabilities["Players"]

UserGameSettings.StartMaximized

Indicates whether Roblox Studio should launch in a maximized window.

FieldValue
typeboolean
tags["NotReplicated","NotScriptable"]
security{"read":"RobloxScriptSecurity","write":"RobloxScriptSecurity"}
thread safetyReadSafe
categoryData
serialization{"can_load":true,"can_save":true}

UserGameSettings.StartScreenPosition

The screen position of the client's window when the application launches.

FieldValue
typeVector2
tags["NotReplicated","NotScriptable"]
security{"read":"RobloxScriptSecurity","write":"RobloxScriptSecurity"}
thread safetyReadSafe
categoryData
serialization{"can_load":true,"can_save":true}

UserGameSettings.StartScreenSize

The size of the client's window when the application launches.

FieldValue
typeVector2
tags["NotReplicated","NotScriptable"]
security{"read":"RobloxScriptSecurity","write":"RobloxScriptSecurity"}
thread safetyReadSafe
categoryData
serialization{"can_load":true,"can_save":true}

UserGameSettings.TouchCameraMovementMode

The camera type in-use by the client while on a mobile device.

FieldValue
typeTouchCameraMovementMode
security{"read":"None","write":"None"}
thread safetyReadSafe
categoryControl
serialization{"can_load":true,"can_save":true}
capabilities["Input"]

UserGameSettings.TouchMovementMode

The type of controls being used by the client on a mobile device.

FieldValue
typeTouchMovementMode
security{"read":"None","write":"None"}
thread safetyReadSafe
categoryControl
serialization{"can_load":true,"can_save":true}
capabilities["Input"]

UserGameSettings.UsedCoreGuiIsVisibleToggle

Indicates whether the user has toggled the visibility of core GUI elements.

FieldValue
typeboolean
security{"read":"RobloxScriptSecurity","write":"RobloxScriptSecurity"}
thread safetyReadSafe
categoryData
serialization{"can_load":true,"can_save":true}

UserGameSettings.UsedCustomGuiIsVisibleToggle

Indicates whether the user has toggled the visibility of custom GUI elements.

FieldValue
typeboolean
security{"read":"RobloxScriptSecurity","write":"RobloxScriptSecurity"}
thread safetyReadSafe
categoryData
serialization{"can_load":true,"can_save":true}

UserGameSettings.UsedHideHudShortcut

Indicates whether the user has used the keyboard shortcut for hiding the HUD.

FieldValue
typeboolean
security{"read":"RobloxScriptSecurity","write":"RobloxScriptSecurity"}
thread safetyReadSafe
categoryData
serialization{"can_load":true,"can_save":true}

UserGameSettings.VignetteEnabled

Indicates whether the VR vignette comfort effect is enabled.

FieldValue
typeboolean
security{"read":"None","write":"RobloxScriptSecurity"}
thread safetyReadSafe
categoryData
serialization{"can_load":true,"can_save":true}

UserGameSettings.VoiceChatVolume

A float between 0 and 2 representing the volume of in-game voice chat.

FieldValue
typefloat
security{"read":"RobloxScriptSecurity","write":"RobloxScriptSecurity"}
thread safetyReadSafe
categoryData
serialization{"can_load":true,"can_save":true}

UserGameSettings.VREnabled

Indicates whether the client is currently running in VR mode.

FieldValue
typeboolean
security{"read":"RobloxScriptSecurity","write":"RobloxScriptSecurity"}
thread safetyReadSafe
categoryData
serialization{"can_load":true,"can_save":true}

UserGameSettings.VRRotationIntensity

The intensity of camera rotation when turning in VR.

FieldValue
typeint
security{"read":"RobloxScriptSecurity","write":"RobloxScriptSecurity"}
thread safetyReadSafe
categoryData
serialization{"can_load":true,"can_save":true}

UserGameSettings.VRSmoothRotationEnabled

Indicates whether smooth rotation is used instead of snap rotation in VR.

FieldValue
typeboolean
security{"read":"None","write":"RobloxScriptSecurity"}
thread safetyReadSafe
categoryData
serialization{"can_load":true,"can_save":true}

Methods

NameType / ReturnsDescription
UserGameSettings:GetCameraYInvertValueintReturns the camera's Y-invert value.
UserGameSettings:GetOnboardingCompletedbooleanChecks if onboarding has been completed.
UserGameSettings:InFullScreenbooleanReturns true if the user's Roblox window is in full screen mode.
UserGameSettings:InStudioModebooleanReturns true if the client's game session is in Roblox Studio.
UserGameSettings:SetCameraYInvertVisible()If called, Roblox toggles the menu option to invert the user's camera y axis.
UserGameSettings:SetGamepadCameraSensitivityVisible()If called, Roblox toggles the menu option to control the camera sensitivity with gamepads.
UserGameSettings:SetOnboardingCompleted()Sets onboarding as completed.

Inherited from Instance

NameType / ReturnsDescription
Instance:AddTag()Applies a tag to the instance.
Instance:childrenInstancesReturns an array of the object's children.
Instance:ClearAllChildren()This method destroys all of an instance's children.
Instance:CloneInstanceCreate a copy of an instance and all its descendants, ignoring instances that are not Archivable.
Instance:cloneInstance
Instance:Destroy()Sets the Instance.Parent property to nil, locks the Instance.Parent property, disconnects all connections, and calls Destroy() on all children.
Instance:destroy()
Instance:FindFirstAncestorInstance?Returns the first ancestor of the Instance whose Instance.Name is equal to the given name.
Instance:FindFirstAncestorOfClassInstance?Returns the first ancestor of the Instance whose Object.ClassName is equal to the given className.
Instance:FindFirstAncestorWhichIsAInstance?Returns the first ancestor of the Instance for whom Object:IsA() returns true for the given className.
Instance:FindFirstChildInstance?Returns the first child of the Instance found with the given name.
Instance:findFirstChildInstance
Instance:FindFirstChildOfClassInstance?Returns the first child of the Instance whose ClassName is equal to the given class name.
Instance:FindFirstChildWhichIsAInstance?Returns the first child of the Instance for whom Object:IsA() returns true for the given className.
Instance:FindFirstDescendantInstance?Returns the first descendant found with the given Instance.Name.
Instance:GetActorActor?Returns the Actor associated with the Instance, if any.
Instance:GetAttributeVariantReturns the value which has been assigned to the given attribute name.
Instance:GetAttributeChangedSignalRBXScriptSignalReturns an event that fires when the given attribute changes.
Instance:GetAttributesDictionaryReturns a dictionary of the instance's attributes.
Instance:GetChildrenInstancesReturns an array containing all of the instance's children.
Instance:getChildrenInstances
Instance:GetDebugIdstringReturns a coded string of the debug ID used internally by Roblox.
Instance:GetDescendantsInstancesReturns an array containing all of the descendants of the instance.
Instance:GetFullNamestringReturns a string describing the instance's ancestry.
Instance:GetStyledVariantReturns the styled or explicitly modified value of the specified property, or else the default property value if it hasn't been styled/modified.
Instance:GetStyledPropertyChangedSignalRBXScriptSignalReturns an event that fires when the given style property changes on the instance.
Instance:GetTagsArrayGets an array of all tags applied to the instance.
Instance:HasTagbooleanCheck whether the instance has a given tag.
Instance:IsAncestorOfbooleanReturns true if an Instance is an ancestor of the given descendant.
Instance:IsDescendantOfbooleanReturns true if an Instance is a descendant of the given ancestor.
Instance:isDescendantOfboolean
Instance:IsPropertyModifiedbooleanReturns true if the value stored in the specified property is not equal to the code-instantiated default.
Instance:QueryDescendantsInstancesReturns an array containing all descendants of the instance that match the selector string.
Instance:Remove()Sets the object's Parent to nil, and does the same for all its descendants.
Instance:remove()
Instance:RemoveTag()Removes a tag from the instance.
Instance:ResetPropertyToDefault()Resets a property to its default value.
Instance:SetAttribute()Sets the attribute with the given name to the given value.
Instance:WaitForChildInstanceReturns the child of the Instance with the given name. If the child does not exist, it will yield the current thread until it does.

Inherited from Object

NameType / ReturnsDescription
Object:GetPropertyChangedSignalRBXScriptSignalGet an event that fires when a given property of the object changes.
Object:IsAbooleanReturns true if an object's class matches or inherits from a given class.
Object:isAboolean

UserGameSettings:GetCameraYInvertValue

Returns the camera's Y-invert value.

Returns

TypeDescription
intThe camera's current Y-axis inversion multiplier.
FieldValue
securityNone
thread safetyUnsafe
capabilities["Input"]

UserGameSettings:GetOnboardingCompleted

Checks whether or not the given onboarding has been completed yet, which is useful for avoiding showing the onboarding animation again.

If onboardingId is not one of the accepted IDs, an error is thrown.

The onboarding process is one-way. This means that, as a developer, you can force the onboarding process to completion but cannot reset it.

See also:

Parameters

NameTypeDefaultDescription
onboardingIdstringThe onboarding ID to inquire about.

Returns

TypeDescription
booleanWhether or not the onboarding in particular has been completed yet.
FieldValue
securityNone
thread safetyUnsafe
capabilities["Players"]

UserGameSettings:InFullScreen

Returns true if the user's Roblox window is in full screen mode.

Returns

TypeDescription
booleanWhether the user's Roblox window is in full screen mode.
FieldValue
securityNone
thread safetyUnsafe
capabilities["Players"]

UserGameSettings:InStudioMode

Returns true if the client's game session is in Roblox Studio.

Returns

TypeDescription
booleanWhether the current client session is running in Roblox Studio.
FieldValue
securityNone
thread safetyUnsafe
capabilities["Players"]

UserGameSettings:SetCameraYInvertVisible

If called, Roblox toggles the menu option to invert the user's camera y axis.

Returns

TypeDescription
()
FieldValue
securityNone
thread safetyUnsafe
capabilities["Input"]

UserGameSettings:SetGamepadCameraSensitivityVisible

If called, Roblox toggles the menu option to control the camera sensitivity with gamepads.

Returns

TypeDescription
()
FieldValue
securityNone
thread safetyUnsafe
capabilities["Input"]

UserGameSettings:SetOnboardingCompleted

Sets the given onboarding as completed, so it won't be shown again to the user the next time they play.

Currently, this function only accepts DynamicThumbstick, and it is used to persistently track whether or not the player has finished the tutorial for the Dynamic Thumbstick control scheme. If onboardingId is not one of the accepted IDs, an error is thrown.

The onboarding process is one-way. This means that, as a developer, you can force the onboarding process to completion but cannot reset it.

See also:

Parameters

NameTypeDefaultDescription
onboardingIdstringThe onboarding ID to set as completed.

Returns

TypeDescription
()
FieldValue
securityNone
thread safetyUnsafe
capabilities["Players"]

Events

NameType / ReturnsDescription
UserGameSettings.FullscreenChangedFires if the user's full screen mode is changed.
UserGameSettings.StudioModeChangedFired when the user's client switches between Studio mode and in-game mode. This gets fired periodically in Roblox Studio when a session starts.

Inherited from Instance

NameType / ReturnsDescription
Instance.AncestryChangedFires when the Instance.Parent property of this object or one of its ancestors is changed.
Instance.AttributeChangedFires whenever an attribute is changed on the Instance.
Instance.ChildAddedFires after an object is parented to this Instance.
Instance.childAdded
Instance.ChildRemovedFires after a child is removed from this Instance.
Instance.DescendantAddedFires after a descendant is added to the Instance.
Instance.DescendantRemovingFires immediately before a descendant of the Instance is removed.
Instance.DestroyingFires immediately before (or is deferred until after) the instance is destroyed via Instance:Destroy().
Instance.StyledPropertiesChangedFires whenever any style property is changed on the instance, including when a property is set to nil.

Inherited from Object

NameType / ReturnsDescription
Object.ChangedFires immediately after a property of the object changes, with some limitations.

UserGameSettings.FullscreenChanged

Fires if the user's full screen mode is changed. The event will only fire on desktop devices that can toggle full screen mode. The game will always be in full screen on mobile devices and consoles.

Parameters

NameTypeDefaultDescription
isFullscreenbooleanWhether the user's Roblox window is now in full screen mode.
FieldValue
securityNone

Code samples: View on Creator Hub (Full-Screen-Mode-Detection).

UserGameSettings.StudioModeChanged

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

NameTypeDefaultDescription
isStudioModebooleanWhether the client session is now running in Roblox Studio.
FieldValue
securityNone