GuiService

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.

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

Used to enable and disable the default controller GUI navigation.

Returns true if any menu of CoreGui is open.

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.

local GuiService = game:GetService("GuiService")

local function printChanged(value)
	if value == "SelectedObject" then
		print("The SelectedObject changed!")
	end
end

GuiService.Changed:Connect(printChanged)

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

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

Returns

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

Parameters

Returns

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

See also:

• Avatar Inspect Menu, an article providing a more detailed explanation of the Inspect and Buy feature and how it works
• GuiService:InspectPlayerFromHumanoidDescription(), allows a developer to bring up the Inspect menu showing the assets listed in this HumanoidDescription object. This is especially useful when what is being worn on a player's avatar on the Roblox platform is not necessarily the same as their in-game appearance
• GuiService:InspectPlayerFromUserId(), 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

Returns

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

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:

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

Returns

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

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:

• Avatar Inspect Menu, an article providing a more detailed explanation of the Inspect and Buy feature and how it works
• GuiService:InspectPlayerFromHumanoidDescription(), allows a developer to bring up the Inspect menu showing the assets listed in this HumanoidDescription object. This is especially useful when what is being worn on a player's avatar on the Roblox platform is not necessarily the same as their in-game appearance
• GuiService:InspectPlayerFromUserId(), 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

Returns

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:

• Avatar Inspect Menu, an article providing a more detailed explanation of the Inspect and Buy feature and how it works
• GuiService:SetInspectMenuEnabled(), allows developers to enable or disable default Inspect and Buy functionality
• GuiService:InspectPlayerFromUserId(), 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.

Parameters

Returns

local GuiService = game:GetService("GuiService")

local humanoidDescription = Instance.new("HumanoidDescription")
humanoidDescription.HatAccessory = "3339374070"
humanoidDescription.BackAccessory = "3339363671"

GuiService:InspectPlayerFromHumanoidDescription(humanoidDescription, "MyPlayer")

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:

• Avatar Inspect Menu, an article providing a more detailed explanation of the Inspect and Buy feature and how it works
• GuiService:SetInspectMenuEnabled(), allows developers to enable or disable default Inspect and Buy functionality. This is especially useful when what is being worn on a player's avatar on the Roblox platform is not necessarily the same as their in-game appearance
• GuiService:InspectPlayerFromHumanoidDescription(), allows a developer to bring up the Inspect menu showing the assets listed in this HumanoidDescription object

Parameters

Returns

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

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

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

Parameters

Returns

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

Parameters

Returns

local Players = game:GetService("Players")
local GuiService = game:GetService("GuiService")

local player = Players.LocalPlayer
local PlayerGui = player:WaitForChild("PlayerGui")

local screenGui = PlayerGui:WaitForChild("ScreenGui")
local startSelection = screenGui:WaitForChild("StartSelection")

-- select the best button on the screen when the StartSelection button is activated
startSelection.Activated:Connect(function()
  GuiService:Select(PlayerGui) 
end)

Opens or closes the player Emotes menu.

Parameters

Returns

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:

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

Parameters

Returns

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:

• Avatar Inspect Menu, an article providing a more detailed explanation of the Inspect and Buy feature and how it works
• GuiService:InspectPlayerFromHumanoidDescription(), allows a developer to bring up the Inspect menu showing the assets listed in this HumanoidDescription object. This is especially useful when what is being worn on a player's avatar on the Roblox platform is not necessarily the same as their in-game appearance
• GuiService:InspectPlayerFromUserId(), 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

Parameters

Returns

Fires when the user closes the Roblox coregui escape menu.

Fires when the user opens the Roblox coregui escape menu.