Engine

GuiService

Show Deprecated
not creatable
service
not replicated

The GuiService is a service which currently allows developers to control what GuiObject is currently being selected by the gamepad navigator. It also allows clients to check if Roblox's main menu is currently open.

This service has a lot of hidden members, which are mainly used internally by Roblox's Class.CoreScript|CoreScripts.

Summary

Properties

  • If activating the Select button on a Gamepad or Backslash will automatically set a GUI as the selected object.

  • hidden
    not replicated
    read parallel

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

  • Used to enable and disable the default controller GUI navigation.

  • read only
    not replicated
    read parallel

    Returns true if any menu of CoreGui is open.

  • hidden
    read only
    not replicated
    read parallel

    Gets the user's preferred transparency as a number between 0 and 1, which indicates how opaque they want the backgrounds of certain UI elements to be. The recommended usage is as a multiplier of an element's BackgroundTransparency. Defaults to 1.

  • hidden
    read only
    not replicated
    read parallel

    Returns true if the user has enabled reduced motion. Defaults to false.

  • Sets the GuiObject currently being focused on by the GUI Navigator (used for Gamepads).

  • read only
    not replicated
    read parallel

    Used to determine the absolute size and position of unobstructed area within top bar space.

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

Methods

Events

Properties

AutoSelectGuiEnabled

read parallel

If activating the Select button on a Gamepad or Backslash will automatically set a GUI as the selected object. Turning this off will mean that Gui navigation will still work if GuiService.GuiNavigationEnabled is enabled but you will have to set GuiService.SelectedObject manually to start Gui navigation.

CoreGuiNavigationEnabled

hidden
not replicated
read parallel

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

GuiNavigationEnabled

read parallel

Used to enable and disable the default controller GUI navigation.

read only
not replicated
read parallel

Returns true if any menu of CoreGui is open.

PreferredTransparency

hidden
read only
not replicated
read parallel

Gets the user's preferred transparency as a number between 0 and 1, which indicates how much more opaque they want the background of UI elements to be. Defaults to 1.

This return value reflects a setting which can be set from the user's side in either the app settings or within the in-experience settings menu via Background Transparency. The default value is 1, indicating that the user prefers the default background transparency. The lowest value is 0, indicating that the user prefers backgrounds to be completely opaque, improving readability and contrast for affected UI. Multiplying an element's GuiObject.BackgroundTransparency with the value returned from PreferredTransparency is the recommended way to use this setting; backgrounds will become more opaque as PreferredTransparency approaches 0. This should be used with Instance:GetPropertyChangedSignal() so that it automatically updates when the user changes their preferred transparency.

Code Samples

Use Preferred Transparency

local DEFAULT_TRANSPARENCY = 0.5
local frame = script.Parent
local function setBackgroundTransparency()
frame.BackgroundTransparency = DEFAULT_TRANSPARENCY * GuiService.PreferredTransparency
end
GuiService:GetPropertyChangedSignal("PreferredTransparency"):Connect(setBackgroundTransparency)
setBackgroundTransparency()

ReducedMotionEnabled

hidden
read only
not replicated
read parallel

Returns true if the user has enabled reduced motion. Defaults to false.

This return value reflects a setting which can be set from the user's side in either the app settings or within the in-experience settings menu via Reduce Motion. A value of true indicates that the user wants motion effects and animations to be reduced or completely removed.

Code Samples

Use Reduced Motion

local DEFAULT_TRANSPARENCY = 0.5
local frame = script.Parent
local endPosition = UDim2.fromScale(0.5, 0.8)
if GuiService.ReducedMotionEnabled then
frame.Position = endPosition
else
local moveTweenInfo = TweenInfo.new(0.5)
local moveTweenProps = {
Position = endPosition
}
local moveTween = TweenService:Create(frame, slideInTweenInfo, slideInTweenProps)
moveTween:Play()
end

SelectedObject

read parallel

Sets the GuiObject currently being focused on by the GUI Navigator (used for Gamepads). This may reset to nil if the object is off-screen.

This property is changed by the GuiObject.SelectionGained and GuiObject.SelectionLost events.

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

Code Samples

Printing When Gamepad Selection Changes

local GuiService = game:GetService("GuiService")
local function printChanged(value)
if value == "SelectedObject" then
print("The SelectedObject changed!")
end
end
GuiService.Changed:Connect(printChanged)

TopbarInset

read only
not replicated
read parallel

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 Instance:GetPropertyChangedSignal().

Code Samples

Responsive Frame Within Available Top Bar Space

local GuiService = game:GetService("GuiService")
local Players = game:GetService("Players")
local screenGui = Instance.new("ScreenGui")
screenGui.IgnoreGuiInset = true
screenGui.Parent = Players.LocalPlayer.PlayerGui
local frame = Instance.new("Frame")
frame.BackgroundColor3 = Color3.fromRGB(0, 255, 0)
frame.Parent = screenGui
GuiService:GetPropertyChangedSignal("TopbarInset"):Connect(function()
local inset = GuiService.TopbarInset
frame.Size = UDim2.new(0, inset.Width, 0, inset.Height)
frame.Position = UDim2.new(0, inset.Min.X, 0, inset.Min.Y)
end)

TouchControlsEnabled

read parallel

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

Methods

AddSelectionParent

void

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

Parameters

selectionName: string
selectionParent: Instance

Returns

void

AddSelectionTuple

void

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

Parameters

selectionName: string

The name of the added selection.

selections: Tuple

The selection(s) added.


Returns

void

CloseInspectMenu

void

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

See also:


Returns

void

GetEmotesMenuOpen

Returns a boolean indicating whether or not the player Emotes menu is open.

Developers can open or close the Emotes menu by calling the GuiService:SetEmotesMenuOpen() function.


Returns

Indicates whether the Emotes menu is open.

GetGameplayPausedNotificationEnabled

This function returns whether or not the gameplay paused notification has been disabled by the developer.

Developers can enable or disable the notification by calling the GuiService:SetGameplayPausedNotificationEnabled() function.

See also:


Returns

Whether or not the gameplay paused notification has been disabled.

GetGuiInset

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.

The inset values supplied by this function only take effect on ScreenGuis that have their IgnoreGuiInset property set to false.


Returns

A tuple of two Vector2 values describing the current specified Gui Inset.

GetInspectMenuEnabled

This function returns whether the Inspect and Buy menu functionality is currently enabled. The feature is enabled by default and can be set using the GuiService:SetInspectMenuEnabled() function.

See also:


Returns

A boolean indicating whether the Inspect Menu feature is enabled.

InspectPlayerFromHumanoidDescription

void

This function allows a developer to bring up the Inspect menu showing the assets listed in this HumanoidDescription object.

This allows further customization with what is shown in the Inspect Menu when players inspect other players in your game. If your game modifies what the players are wearing, you can instead give the Inspect Menu a HumanoidDescription object that represents what a player is wearing and those items will be shown. You should pass a name as well to represent the name of the player that will be inspected.

See also:

Parameters

humanoidDescription: Instance

A HumanoidDescription object that contains the assets to show in the Inspect menu.

name: string

The name of the player being Inspected to show in the Inspect menu.


Returns

void

Code Samples

Opening an Inspect Menu with a HumanoidDescription

local GuiService = game:GetService("GuiService")
local humanoidDescription = Instance.new("HumanoidDescription")
humanoidDescription.HatAccessory = "3339374070"
humanoidDescription.BackAccessory = "3339363671"
GuiService:InspectPlayerFromHumanoidDescription(humanoidDescription, "MyPlayer")

InspectPlayerFromUserId

void

This function allows the 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 game.

This shows the same information as the "Currently Wearing" tab on the specified user's profile.

See also:

Parameters

userId: number

The UserId of the player to inspect.


Returns

void

Code Samples

Opening the Inspect Menu for a UserId

local GuiService = game:GetService("GuiService")
GuiService:InspectPlayerFromUserId(772462)

IsTenFootInterface

Returns true if the client is using the ten foot interface, which is a special version of Roblox's UI, exclusive to consoles. This is the only guaranteed way to verify if the user is on a console or not.


Returns

RemoveSelectionGroup

void

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

Parameters

selectionName: string

Returns

void

Select

void

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

Parameters

selectionParent: Instance

The parent of selection whose descendants are searched.


Returns

void

Code Samples

Use Preferred Transparency

local DEFAULT_TRANSPARENCY = 0.5
local frame = script.Parent
local function setBackgroundTransparency()
frame.BackgroundTransparency = DEFAULT_TRANSPARENCY * GuiService.PreferredTransparency
end
GuiService:GetPropertyChangedSignal("PreferredTransparency"):Connect(setBackgroundTransparency)
setBackgroundTransparency()

SetEmotesMenuOpen

void

Opens or closes the player Emotes menu.

Parameters

isOpen: bool

Returns

void

SetGameplayPausedNotificationEnabled

void

This method allows developers to disable the built-in notification when a players gameplay is paused. They can then add in their own UI if they wish to customize it.

Developers can query whether the notification is enabled by calling the GuiService:GetGameplayPausedNotificationEnabled() function.

See also:

Parameters

enabled: bool

Whether or not the built-in notification GUI is disabled.


Returns

void

SetInspectMenuEnabled

void

This function allows developers to enable or disable default Inspect and Buy functionality. This is useful when you want to disable the feature in your game, entirely or during certain parts of your game (such as a cutscene). The feature is enabled by default.

The code sample below demonstrates how to disable the Inspect Menu for your game:


local GuiService = game:GetService("GuiService")
GuiService:SetInspectMenuEnabled(false)

See also:

Parameters

enabled: bool

A boolean indicating whether to enable or disable the Inspect Menu feature.


Returns

void

Events

Fires when the user closes the Roblox coregui escape menu.


Fires when the user opens the Roblox coregui escape menu.