GuiService

If activated, the Select button on a gamepad or Backslash will automatically set a GUI as the selected object. Disabling this means that GUI navigation will still work if GuiNavigationEnabled is enabled, but you will have to set SelectedObject manually to start navigation.

Toggles whether or not objects in the CoreGui can be navigated using a gamepad.

Used to enable and disable the default controller GUI navigation.

This property tells whether or not a modal dialog is visible, such as the game menu or a purchase prompt.

The IsWindows property defines if the user is playing on a computer running Windows.

Returns true if any menu of CoreGui is open.

Gets the player's preferred text size as an PreferredTextSize value of Medium (default), Large, Larger, or Largest. This property maps to the Text Size setting available to players from the Roblox and in‑game Settings menus, and it can be combined with Object.GetPropertyChangedSignal() to detect text size setting changes for purposes of adjusting UI.

When working with UI elements, note the following behaviors:

• Text that is constrained to a minimum and/or maximum size through a UITextSizeConstraint will not shrink below or expand above the set MinTextSize/MaxTextSize, regardless of the player's text size setting.

• When TextScaled is enabled for a TextLabel or TextButton, the element's text will not be scaled by the PreferredTextSize value.

• UI elements with AutomaticSize enabled will shrink/grow as PreferredTextSize decreases/increases (element bounds will resize to fit the resized text).

• When TextWrapped is enabled for a TextLabel or TextButton, the element's text will wrap to additional lines as PreferredTextSize increases, within limits of the element's absolute size.

• The results returned by TextService:GetTextSize() and TextService:GetTextBoundsAsync() honor changes related to PreferredTextSize.

Gets the player's preferred transparency as a number between 0 and 1. This property maps to the Background Transparency setting available to players from the Roblox and in‑experience Settings menus, and it can be combined with Object.GetPropertyChangedSignal() to detect transparency setting changes for purposes of adjusting UI.

A value of 1 (default) indicates the player prefers the default background transparency, while a value of 0 indicates the player prefers fully opaque (non‑transparent) background transparency for improved readability and contrast. Multiplying a UI element's BackgroundTransparency with PreferredTransparency is the recommended approach, such that backgrounds become more opaque as PreferredTransparency approaches 0.

Returns true if the player has enabled reduced motion, indicating that they want motion effects and animations to be reduced or completely removed. This property maps to the Reduce Motion toggle available from the Roblox and in‑experience Settings menus. See accessibility guidelines for usage recommendations.

Sets the GuiObject currently being focused on by the GUI navigator. This may reset to nil if the object is off screen.

This property is changed by the SelectionGained and SelectionLost events. If you would like to determine when this property changes without tracking these events for all GUI elements, you can use the Changed event.

Returns a Rect object representing the unoccupied area between the Roblox left-most controls and the edge of the device safe area.

The value is dynamic and can be expected to change based on the visibility of UI controls such as changing the local player's Health property, usage of StarterGui:SetCoreGuiEnabled(), changing the size and position of Roblox UI Controls, and/or others. For this reason, it's recommend that you detect and react to changes of this property with Object:GetPropertyChangedSignal().

Used to enable and disable touch controls and touch control display UI. Defaults to true.

Read-only property which represents the physical rendering size of the viewport:

• DisplaySize.Small — Most tablet/mobile/handheld devices
• DisplaySize.Medium — Most laptops and monitors
• DisplaySize.Large — Most TVs or larger

You can listen for changes to this property through the GetPropertyChangedSignal() method to adapt UI to various display sizes.

Creates a selection group where gamepad GUI navigation will only consider selectable objects that are within the group (children of selectionParent). An example is when you have a menu pop open and there are other selectable objects on the screen, possibly from previous menus, but you want the user to only be able to select GUI objects in the new menu.

Functions similarly to GuiService:AddSelectionParent(), but you can give it a tuple of GuiObject that you want to be contained in the group.

This method closes the Avatar Inspect Menu, if open, when run from a LocalScript.

See Also#

• InspectPlayerFromHumanoidDescription() which allows the avatar inspection menu to appear showing the assets listed in a HumanoidDescription object.

• InspectPlayerFromUserId() which allows the avatar inspection menu to appear showing the user that has the given UserId.

Dismisses the notification identified by notificationId, which is the string returned when the notification was created with SendNotification(). If the notification was created with an OnDismiss callback, that callback is invoked. Returns true when a matching notification is found and dismissed, or false when no active notification has the given notificationId.

Returns a boolean indicating whether or not the player emotes menu is open. You can open or close the emotes menu by calling the SetEmotesMenuOpen() method.

This method returns whether or not the Player.GameplayPaused notification has been disabled through SetGameplayPausedNotificationEnabled().

See also Workspace.StreamingIntegrityMode and StreamingIntegrityMode for more details on when gameplay is paused.

Returns two Vector2 values representing the inset of user GUIs in pixels, from the top‑left corner of the screen and the bottom‑right corner of the screen respectively.

Note that the inset values supplied by this method only take effect on ScreenGuis that have their IgnoreGuiInset property set to false.

Takes an ScreenInsets value and returns a Rect describing the inset region relative to the CoreUISafeInsets area, effectively the usable rectangle for a particular ScreenInsets area.

On a mobile device screen, for example, querying GetInsetArea(Enum.ScreenInsets.None) may return a result such as -59, -58, 792, 334, meaning the usable rectangle for ScreenInsets.None has a top‑left corner 59 pixels left and 58 pixels up from the top‑left corner of the core UI area, and a bottom‑right corner 792 pixels right and 334 pixels down from the top‑left corner of the core UI area.

This method returns whether the Avatar Inspect Menu is currently enabled. The feature is enabled by default and can be disabled using the SetInspectMenuEnabled() method.

This method allows the Avatar Inspect Menu to appear showing the assets listed in a HumanoidDescription object. This allows further customization with what is shown in the inspection menu when players inspect other players in your experience.

See also InspectPlayerFromUserId() which allows the avatar inspection menu to appear showing the user that has the given UserId.

This method allows the Avatar Inspect Menu to appear showing the user that has the given UserId. This is especially useful when you want to inspect players who aren't in the current experience.

See also InspectPlayerFromHumanoidDescription() which allows you to bring up the avatar inspection menu showing the assets listed in a HumanoidDescription object.

Returns true if the client is using the ten foot interface, a special version of Roblox's UI exclusive to consoles.

Note that you should not use this property in an attempt to verify if the player is on a console or not. Instead, consider reading ViewportDisplaySize. This method is hardcoded to return true whenever the client runs on a console, regardless of how the player is actually interacting with the device, making it an unreliable proxy for rendering context.

Removes a group that was created with AddSelectionParent() or AddSelectionTuple().

When called on an instance selectionParent that is the PlayerGui or a descendant of it, the engine searches all available selectable, visible and on-screen GuiObjects that are descendants of selectionParent and sets the SelectedObject to the GuiObject with the smallest SelectionOrder.

Displays a notification built from the notificationInfo dictionary using Roblox's native notification UI, and returns a unique identifier string for the notification. The following fields of notificationInfo are recognized:

The returned identifier can be passed to DismissNotification() to dismiss the notification programmatically; an empty string is returned if the notification could not be queued.

Opens or closes the player emotes menu.

This method lets you disable the built-in notification when a player's gameplay is paused. You can then add in your own UI and customize it.

You can query whether the notification is enabled by calling the GetGameplayPausedNotificationEnabled() method.

See also Workspace.StreamingIntegrityMode and StreamingIntegrityMode for more details on when gameplay is paused.

This method allows you to enable or disable the Avatar Inspect Menu. The feature is enabled by default.

Fires when the user closes the Roblox CoreGui escape menu.

Fires when the user opens the Roblox CoreGui escape menu.