PcoWSkbVqDnWTu_dm2ix
We use cookies on this site to enhance your user experience
Collapse Sidebar

GuiService

Show deprecated

GuiService

Show deprecated

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 CoreScript|CoreScripts.

Properties

bool

AutoSelectGuiEnabled

If the select button on a gamepad will automatically set a GUI as the selected object when the Select button is pressed. Turning this off will mean that Gui navigation will still work if GuiNavigationEnabled is enabled but you will have to set SelectedObject manually to start Gui navigation.

bool

CoreGuiNavigationEnabled

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

bool

GuiNavigationEnabled

Used to enable and disable the default controller GUI navigation.

bool

MenuIsOpen

[ReadOnly] [NotReplicated]

Returns true if any menu of CoreGui is open

GuiObject

SelectedObject

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

Functions

void

AddSelectionParent ( string selectionName , Instance selectionParent )

Creates a gui selection group where gamepad gui navigation will only consider selectable gui objects that are within the group (children of selectionParent).

void

AddSelectionTuple ( string selectionName , Tuple selections )

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

void

CloseInspectMenu ( )

bool

GetEmotesMenuOpen ( )

Tuple

GetGuiInset ( )

Returns two DataType/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.

bool

GetInspectMenuEnabled ( )

void

InspectPlayerFromHumanoidDescription ( Instance humanoidDescription , string name )

Allows a developer to bring up the Inspect menu showing the assets listed in this HumanoidDescription object

void

InspectPlayerFromUserId ( int64 userId )

Allows the Inspect Menu to appear showing the user that has the given Player/UserId|UserId

bool

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.

void

RemoveSelectionGroup ( string selectionName )

Removes a group that was created with GuiService/AddSelectionParent or GuiService/AddSelectionTuple.

void

SetEmotesMenuOpen ( bool isOpen )

void

SetInspectMenuEnabled ( bool enabled )

Allows developers to enable or disable default Inspect and Buy functionality

void

SetUiMessage ( UiMessageType msgType , string uiMessage )

Sets the GuiService’s Ui message.

Events

RBXScriptSignal

MenuClosed ( )

Fires when the user closes the Roblox coregui escape menu.

RBXScriptSignal

MenuOpened ( )

Fires when the user opens the Roblox coregui escape menu.