PcoWSkbVqDnWTu_dm2ix
The Developer Hub is now deprecated and information on this page may no longer be accurate. To see our new and improved documentation, please click here. You can read more about the future of documentation here.
Collapse Sidebar
  1. API Reference
  2. GuiService

GuiService

Show deprecated
Hide content
  1. apireference
  2. guiservice

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.
Folder

CoreEffectFolder

[Hidden] [NotReplicated]
Folder

CoreGuiFolder

[Hidden] [NotReplicated]
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

IsModalDialog

[ReadOnly] [NotReplicated] [Deprecated]

Indicates whether a modal dialog is visible.
bool

IsWindows

[ReadOnly] [NotReplicated] [Deprecated]

Indicates whether the user is playing on a computer running Windows.
bool

MenuIsOpen

[ReadOnly] [NotReplicated]

Returns true if any menu of CoreGui is open
GuiObject

SelectedCoreObject

[Hidden] [NotReplicated]
GuiObject

SelectedObject

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

TouchControlsEnabled

Determines whether touch controls are enabled. Defaults to true.

Inherited from Instance: Show Hide

bool

Archivable

Determines if an Instance can be cloned using /Instance/Clone or saved to file.
string

ClassName

[ReadOnly] [NotReplicated]

A read-only string representing the class this Instance belongs to
int

DataCost

[Hidden] [ReadOnly] [NotReplicated] [Deprecated]

The cost of saving the instance using data persistence.
string

Name

A non-unique identifier of the Instance
Instance

Parent

[NotReplicated]

Determines the hierarchical parent of the Instance
bool

RobloxLocked

[Hidden]

A deprecated property that used to protect CoreGui objects
int64

SourceAssetId

[Hidden] [NotReplicated]
bool

archivable

[Hidden] [NotReplicated] [Deprecated]
string

className

[ReadOnly] [NotReplicated] [Deprecated]

Functions

void

AddCenterDialog ( Instance dialog , CenterDialogType centerDialogType , Function showFunction , Function hideFunction )

void

AddKey ( string key )

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 )

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

Beware that the second argument is not a table, but rather the first of several GuiObject in the tuple. To pass the contents of a table, use unpack/table.unpack:

local frame = script.Parent
-- Passing various GuiObject individually
GuiService:AddSelectionTuple("InventoryButtons", frame.Sort, frame.Trash, frame.Drop)
-- Unpacking a table of GuiObject (unpack/table.unpack are equivalent)
local inventoryButtons = { frame.Sort, frame.Trash, frame.Drop }
GuiService:AddSelectionTuple("InventoryButtons", unpack(inventoryButtons))
void

AddSpecialKey ( SpecialKey key )

void

BroadcastNotification ( string data , int notificationType )

void

ClearError ( )

void

CloseInspectMenu ( )

Closes the Inspect Menu, if open
bool

CloseStatsBasedOnInputString ( string input )

void

ForceTenFootInterface ( bool isForced )

int

GetBrickCount ( )

Instance

GetClosestDialogToPosition ( Vector3 position )

bool

GetEmotesMenuOpen ( )

Checks if the player Emotes menu is open.
ConnectionError

GetErrorCode ( )

string

GetErrorMessage ( )

[Deprecated]
ConnectionError

GetErrorType ( )

bool

GetGameplayPausedNotificationEnabled ( )

Returns whether or not the Player/GameplayPaused|gameplay paused notification has been disabled by the developer
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 ( )

Returns whether the Inspect and Buy menu functionality is enabled
Dictionary

GetNotificationTypeList ( )

int

GetResolutionScale ( )

Dictionary

GetSafeZoneOffsets ( )

Vector2

GetScreenResolution ( )

[Yields]
string

GetUiMessage ( )

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
void

InspectPlayerFromUserIdWithCtx ( int64 userId , string ctx )

bool

IsMemoryTrackerEnabled ( )

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

OpenBrowserWindow ( string url )

[Deprecated]
void

OpenNativeOverlay ( string title , string url )

[Deprecated]
void

RemoveCenterDialog ( Instance dialog )

void

RemoveKey ( string key )

void

RemoveSelectionGroup ( string selectionName )

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

RemoveSpecialKey ( SpecialKey key )

void

SetEmotesMenuOpen ( bool isOpen )

Opens or closes the player Emotes menu.
void

SetGameplayPausedNotificationEnabled ( bool enabled )

Allows developers to disable the built-in notification when a players gameplay is paused
void

SetGlobalGuiInset ( int x1 , int y1 , int x2 , int y2 )

void

SetInspectMenuEnabled ( bool enabled )

Allows developers to enable or disable default Inspect and Buy functionality
void

SetMenuIsOpen ( bool open , string menuName )

void

SetSafeZoneOffsets ( float top , float bottom , float left , float right )

void

SetUiMessage ( UiMessageType msgType , string uiMessage )

Sets the GuiService’s Ui message.
bool

ShowStatsBasedOnInputString ( string input )

void

ToggleFullscreen ( )

Inherited from Instance: Show Hide

void

ClearAllChildren ( )

This function destroys all of an Instance’s children.
Instance

Clone ( )

Create a copy of an object and all its descendants, ignoring objects that are not Instance/Archivable|Archivable
void

Destroy ( )

Sets the Instance/Parent property to nil, locks the Instance/Parent property, disconnects all connections, and calls Destroy on all children.
Instance

FindFirstAncestor ( string name )

Returns the first ancestor of the Instance whose Instance/Name is equal to the given name.
Instance

FindFirstAncestorOfClass ( string className )

Returns the first ancestor of the Instance whose Instance/ClassName is equal to the given className.
Instance

FindFirstAncestorWhichIsA ( string className )

Returns the first ancestor of the Instance for whom Instance/IsA returns true for the given className.
Instance

FindFirstChild ( string name , bool recursive )

Returns the first child of the Instance found with the given name.
Instance

FindFirstChildOfClass ( string className )

Returns the first child of the Instance whose Instance/ClassName|ClassName is equal to the given className.
Instance

FindFirstChildWhichIsA ( string className , bool recursive )

Returns the first child of the Instance for whom Instance/IsA returns true for the given className.
Instance

FindFirstDescendant ( string name )

Returns the first descendant found with the given Instance/Name.
Actor

GetActor ( )

Returns the Actor associated with the Instance, usually the first Actor ancestor
Variant

GetAttribute ( string attribute )

Returns the attribute which has been assigned to the given name
RBXScriptSignal

GetAttributeChangedSignal ( string attribute )

Returns an event that fires when the given attribute changes
Dictionary

GetAttributes ( )

Returns a dictionary of string → variant pairs for each of the Instance|Instance’s attributes
Objects

GetChildren ( )

Returns an array containing all of the Instance’s children.
string

GetDebugId ( int scopeLength )

[NotBrowsable]

Returns a coded string of the Instances DebugId used internally by Roblox.
Array

GetDescendants ( )

[CustomLuaState]

Returns an array containing all of the descendants of the instance
string

GetFullName ( )

Returns a string describing the Instance’s ancestry.
RBXScriptSignal

GetPropertyChangedSignal ( string property )

Get an event that fires when a given property of an object changes.
bool

IsA ( string className )

[CustomLuaState]

Returns true if an Instance’s class matches or inherits from a given class
bool

IsAncestorOf ( Instance descendant )

Returns true if an Instance is an ancestor of the given descendant.
bool

IsDescendantOf ( Instance ancestor )

Returns true if an Instance is a descendant of the given ancestor.
void

Remove ( )

[Deprecated]

Sets the object’s Parent to nil, and does the same for all its descendants.
void

SetAttribute ( string attribute , Variant value )

Sets the attribute with the given name to the given value
Instance

WaitForChild ( string childName , double timeOut )

[CustomLuaState] [CanYield]

Returns the child of the Instance with the given name. If the child does not exist, it will yield the current thread until it does.
Objects

children ( )

[Deprecated]

Returns an array of the object’s children.
Instance

clone ( )

[Deprecated]
void

destroy ( )

[Deprecated]
Instance

findFirstChild ( string name , bool recursive )

[Deprecated]
Objects

getChildren ( )

[Deprecated]
bool

isA ( string className )

[Deprecated] [CustomLuaState]
bool

isDescendantOf ( Instance ancestor )

[Deprecated]
void

remove ( )

[Deprecated]

Events

RBXScriptSignal

BrowserWindowClosed ( )

[Deprecated]
RBXScriptSignal

CloseInspectMenuRequest ( )

RBXScriptSignal

CoreGuiRenderOverflowed ( )

RBXScriptSignal

EmotesMenuOpenChanged ( bool isOpen )

RBXScriptSignal

ErrorMessageChanged ( string newErrorMessage )

[Deprecated]
RBXScriptSignal

InspectMenuEnabledChangedSignal ( bool enabled )

RBXScriptSignal

InspectPlayerFromHumanoidDescriptionRequest ( Instance humanoidDescription , string name )

RBXScriptSignal

InspectPlayerFromUserIdWithCtxRequest ( int64 userId , string ctx )

RBXScriptSignal

KeyPressed ( string key , string modifiers )

RBXScriptSignal

MenuClosed ( )

Fires when the user closes the Roblox coregui escape menu.
RBXScriptSignal

MenuOpened ( )

Fires when the user opens the Roblox coregui escape menu.
RBXScriptSignal

NativeClose ( )

RBXScriptSignal

NetworkPausedEnabledChanged ( bool enabled )

RBXScriptSignal

Open9SliceEditor ( Instance selectedImageObject )

RBXScriptSignal

SafeZoneOffsetsChanged ( )

RBXScriptSignal

ShowLeaveConfirmation ( )

RBXScriptSignal

SpecialKeyPressed ( SpecialKey key , string modifiers )

RBXScriptSignal

UiMessageChanged ( UiMessageType msgType , string newUiMessage )

Inherited from Instance: Show Hide

RBXScriptSignal

AncestryChanged ( Instance child , Instance parent )

Fires when the Instance/Parent property of the object or one of its ancestors is changed.
RBXScriptSignal

AttributeChanged ( string attribute )

Fires whenever an attribute is changed on the Instance
RBXScriptSignal

Changed ( string property )

Fired immediately after a property of an object changes.
RBXScriptSignal

ChildAdded ( Instance child )

Fires after an object is parented to this Instance.
RBXScriptSignal

ChildRemoved ( Instance child )

Fires after a child is removed from this Instance.
RBXScriptSignal

DescendantAdded ( Instance descendant )

Fires after a descendant is added to the Instance
RBXScriptSignal

DescendantRemoving ( Instance descendant )

Fires immediately before a descendant of the Instance is removed.
RBXScriptSignal

Destroying ( )

Fires immediately before the instance is destroyed via Instance/Destroy.
RBXScriptSignal

childAdded ( Instance child )

[Deprecated]

Callback

void

SendCoreUiNotification ( string title , string text )

Dragger HapticService