GuiService

Offers numerous properties and methods for working with GuiObjects, player preferences, and other UI‑related tasks.

Memory category: Instances
Own members: 112
Inherited members: 75
Subclasses: 0
Siblings: 608

Properties48

Inherited fromObject2

Property categoryData

Object.ClassName: string
A read-only string representing the class this Object belongs to.
- Read only
Object.className: string
Deprecated: This deprecated property is a variant of Object.ClassName which should be used instead.
- Deprecated
- Read only
Use ClassName instead.

Inherited fromInstance21

Property categoryBehavior

Instance.Archivable: boolean
Determines if an Instance and its descendants can be cloned using Instance:Clone(), and can be saved/published.
Instance.archivable: boolean
Deprecated: This deprecated property is a variant of Instance.Archivable which should be used instead.
- Deprecated
- Hidden
- Not replicated
- Load only
Use Archivable instead.

Property categoryData

Instance.Attributes: string
- Hidden
- Not scriptable
- Read only
- Roblox engine security
Instance.AttributesReplicate: string
- Hidden
- Not scriptable
- Roblox engine security
Instance.AttributesSerialize: string
- Hidden
- Not replicated
- Not scriptable
- Roblox engine security
Instance.HistoryId: UniqueId
- Hidden
- Not replicated
- Not scriptable
- Roblox engine security
Instance.Name: string
A non-unique identifier of the Instance.
Instance.Parent: Instance
Determines the hierarchical parent of the Instance.
- Not replicated
- Load only
Instance.PredictionMode: Enum.PredictionMode
Reflects the client-side prediction mode applied to the instance under server-authoritative physics.
- Not scriptable
- Read only
Instance.PropertyStatusStudio: Enum.PropertyStatus
- Hidden
- Not scriptable
- Read only
- Roblox engine security
Instance.RobloxLocked: boolean
A deprecated property that used to protect CoreGui objects.
- Hidden
- Plugin security
Instance.SerializedOverrides: string
- Hidden
- Not replicated
- Not scriptable
- Roblox engine security
Instance.SourceAssetId: number
- Hidden
- Roblox script security
Instance.Tags: SharedString
- Hidden
- Not scriptable
- Roblox engine security
Instance.UniqueId: UniqueId
A unique identifier for the instance.
- Not replicated
- Read: Roblox script security
- Write: Roblox engine security
Instance.numExpectedDirectChildren: number
- Hidden
- Not scriptable
Instance.DataCost: number
- Deprecated
- Hidden
- Read only
- Local user security

Property categoryPermissions

Instance.Capabilities: SecurityCapabilities
The set of capabilities allowed to be used for scripts inside this container.
- Capabilities: CapabilityControl
Instance.DefinesCapabilities: boolean
- Hidden
- Not scriptable
- Roblox engine security
Instance.IsInSandbox: boolean
Indicates whether the instance is inside a sandboxed container.
- Not scriptable
- Read only
Instance.Sandboxed: boolean
When enabled, the instance can only access abilities in its Capabilities list.
- Not replicated
- Capabilities: CapabilityControl

Defined byGuiService25

Property categoryData

GuiService.AutoSelectGuiEnabled: boolean
If activated, the Select button on a gamepad or Backslash will automatically set a GUI as the selected object.
- Capabilities: Input + UI
GuiService.CoreEffectFolder: Folder
- Hidden
- Not replicated
- Roblox script security
- Read capabilities: UI
GuiService.CoreGuiFolder: Folder
- Hidden
- Not replicated
- Roblox script security
- Read capabilities: UI
GuiService.CoreGuiNavigationEnabled: boolean
Toggles whether or not objects in the CoreGui can be navigated using a gamepad.
- Hidden
- Not replicated
- Capabilities: Input + UI
GuiService.CoreUISafeAreaInsetBottomRight: Vector2
- Hidden
- Not scriptable
- Read only
- Roblox engine security
- Read capabilities: UI
GuiService.CoreUISafeAreaInsetTopLeft: Vector2
- Hidden
- Not scriptable
- Read only
- Roblox engine security
- Read capabilities: UI
GuiService.DisplayScalingMode: Enum.DisplayScalingMode
- Hidden
- Roblox script security
- Read capabilities: UI
GuiService.FullscreenViewport: Rect
- Hidden
- Not scriptable
- Read only
- Roblox engine security
- Read capabilities: UI
GuiService.GuiNavigationEnabled: boolean
Used to enable and disable the default controller GUI navigation.
- Capabilities: Input + UI
GuiService.HardwareSafeAreaInsetBottomRight: Vector2
- Hidden
- Not scriptable
- Read only
- Roblox engine security
- Read capabilities: UI
GuiService.HardwareSafeAreaInsetTopLeft: Vector2
- Hidden
- Not scriptable
- Read only
- Roblox engine security
- Read capabilities: UI
GuiService.MenuIsOpen: boolean
Returns true if any menu of CoreGui is open.
- Read only
- Read capabilities: UI
- Save only
GuiService.PreferredTextSize: Enum.PreferredTextSize
Gets the player's preferred text size as an PreferredTextSize value.
- Read only
- Read capabilities: UI
GuiService.PreferredTransparency: number
Gets the player's preferred transparency as a number between 0 and 1.
- Hidden
- Read only
- Read capabilities: UI
GuiService.ReducedMotionEnabled: boolean
Returns true if the player has enabled reduced motion.
- Hidden
- Read only
- Read capabilities: UI
GuiService.ScreenContextRawScreenScale: number
- Hidden
- Not scriptable
- Read only
- Roblox engine security
- Read capabilities: UI
GuiService.ScreenContextTopbarInset: Rect
- Hidden
- Not scriptable
- Read only
- Roblox engine security
- Read capabilities: UI
GuiService.SelectedCoreObject: GuiObject
- Hidden
- Not replicated
- Roblox script security
- Read capabilities: UI
GuiService.SelectedObject: GuiObject
Sets the GuiObject currently being focused on by the GUI navigator.
- Capabilities: Input + UI
GuiService.TopbarInset: Rect
Used to determine the absolute size and position of unobstructed area within top bar space.
- Read only
- Read capabilities: UI
GuiService.TouchControlsEnabled: boolean
Used to enable and disable touch controls and touch control display UI. Defaults to true.
- Capabilities: Input + UI
GuiService.ViewportDisplaySize: Enum.DisplaySize
Read-only property which represents the physical rendering size of the viewport.
- Read only
- Read capabilities: UI
GuiService.ViewportSizeInMM: Vector2
- Read only
- Roblox script security
- Read capabilities: UI
GuiService.IsModalDialog: boolean
Deprecated: This item is deprecated. Do not use it for new work.
Indicates whether a modal dialog is visible.
- Deprecated
- Read only
- Read capabilities: UI
GuiService.IsWindows: boolean
Deprecated: This item is deprecated. Do not use it for new work.
Indicates whether the user is playing on a computer running Windows.
- Deprecated
- Read only
- Read capabilities: UI

Methods106

Inherited fromObject3

Object:GetPropertyChangedSignal(property: string): RBXScriptSignal
Get an event that fires when a given property of the object changes.
Parameters
Parameter Description
property: string
The property to connect to.
Returns
Type Description
RBXScriptSignal
A signal that fires whenever the property changes.
Object:IsA(className: string): boolean
Returns true if an object's class matches or inherits from a given class.
- Custom Lua state
- Thread safe
Parameters
Parameter Description
className: string
The class against which the Object's class will be checked. Case-sensitive.
Returns
Type Description
boolean
Describes whether the Object's class matched or is a subclass of the given class.
Object:isA(className: string): boolean
Deprecated: This deprecated function is a variant of Object:IsA() which should be used instead.
- Deprecated
- Custom Lua state
Parameters
Parameter
className: string
Returns
Type
boolean
Use IsA instead.

Parameters
Parameter	Description
`property: string`	The property to connect to.

Returns
Type	Description
`RBXScriptSignal`	A signal that fires whenever the property changes.

Parameters
Parameter	Description
`className: string`	The class against which the Object's class will be checked. Case-sensitive.

Returns
Type	Description
`boolean`	Describes whether the Object's class matched or is a subclass of the given class.

Parameters
Parameter
`className: string`

Returns
Type
`boolean`

Inherited fromInstance39

Instance:AddTag(tag: string)
Applies a tag to the instance.
Parameters
Parameter Description
tag: string
The tag to apply to the instance.
Instance:ClearAllChildren()
This method destroys all of an instance's children.
Instance:Clone(): Instance
Create a copy of an instance and all its descendants, ignoring instances that are not Archivable.
- Capabilities: CreateInstances
- Simulation access
Returns
Type Description
Instance
A copy of the instance, or nil if the instance is not Archivable.
Instance:Destroy()
Sets the Instance.Parent property to nil, locks the Instance.Parent property, disconnects all connections, and calls Destroy() on all children.
Instance:FindFirstAncestor(name: string): Instance
Returns the first ancestor of the Instance whose Instance.Name is equal to the given name.
- Thread safe
Parameters
Parameter Description
name: string
The Instance.Name to be looked for.
Returns
Type Description
Instance
The Instance found.
Instance:FindFirstAncestorOfClass(className: string): Instance
Returns the first ancestor of the Instance whose Object.ClassName is equal to the given className.
- Thread safe
Parameters
Parameter Description
className: string
The Object.ClassName to be looked for.
Returns
Type Description
Instance
The Instance found.
Instance:FindFirstAncestorWhichIsA(className: string): Instance
Returns the first ancestor of the Instance for whom Object:IsA() returns true for the given className.
- Thread safe
Parameters
Parameter Description
className: string
The Object.ClassName to be looked for.
Returns
Type Description
Instance
The Instance found.
Instance:FindFirstChild(name: string, recursive: boolean? = false): Instance
Returns the first child of the Instance found with the given name.
- Thread safe
- Simulation access
Parameters
Parameter Description
name: string
The Instance.Name to be searched for.
recursive: boolean? = false
Whether or not the search should be conducted recursively.
Returns
Type Description
Instance
The Instance found.
Instance:FindFirstChildOfClass(className: string): Instance
Returns the first child of the Instance whose ClassName is equal to the given class name.
- Thread safe
Parameters
Parameter Description
className: string
The Object.ClassName to be looked for.
Returns
Type Description
Instance
The Instance found.
Instance:FindFirstChildWhichIsA(className: string,recursive: boolean? = false,): Instance
Returns the first child of the Instance for whom Object:IsA() returns true for the given className.
- Thread safe
- Simulation access
Parameters
Parameter Description
className: string
The Object.ClassName to be searched for.
recursive: boolean? = false
Whether or not the search should be conducted recursively.
Returns
Type Description
Instance
The Instance found.
Instance:FindFirstDescendant(name: string): Instance
Returns the first descendant found with the given Instance.Name.
- Thread safe
Parameters
Parameter Description
name: string
The Instance.Name to search for.
Returns
Type Description
Instance
The Instance found.
Instance:GetActor(): Actor
Returns the Actor associated with the Instance, if any.
- Thread safe
Returns
Type Description
Actor
The Actor found.
Instance:GetAttribute(attribute: string): any
Returns the value which has been assigned to the given attribute name.
- Thread safe
- Simulation access
Parameters
Parameter Description
attribute: string
The name of the attribute being retrieved.
Returns
Type Description
any
The value which has been assigned to the given attribute name. If no attribute has been assigned, nil is returned.
Instance:GetAttributeChangedSignal(attribute: string): RBXScriptSignal
Returns an event that fires when the given attribute changes.
Parameters
Parameter Description
attribute: string
The name of the specified attribute for which the change signal is being returned.
Returns
Type Description
RBXScriptSignal
An event that fires when the given attribute changes.
Instance:GetAttributes(): { [string]: any }
Returns a dictionary of the instance's attributes.
- Custom Lua state
- Thread safe
- Simulation access
Returns
Type Description
{ [string]: any }
A dictionary of string → variant pairs for each attribute where the string is the name of the attribute and the variant is a non-nil value.
Instance:GetChildren(): { Instance }
Returns an array containing all of the instance's children.
- Thread safe
- Simulation access
Returns
Type Description
{ Instance }
An array containing the instance's children.
Instance:GetDebugId(scopeLength: number? = 4): string
Returns a coded string of the debug ID used internally by Roblox.
- Not browsable
- Plugin security
Parameters
Parameter Description
scopeLength: number? = 4
The scope length.
Returns
Type Description
string
The Debug ID string.
Instance:GetDescendants(): { Instance }
Returns an array containing all of the descendants of the instance.
- Custom Lua state
- Thread safe
- Simulation access
Returns
Type Description
{ Instance }
An array containing the instance's descendants.
Instance:GetFullName(): string
Returns a string describing the instance's ancestry.
- Thread safe
- Simulation access
Returns
Type Description
string
The full name of the Instance.
Instance:GetStyled(name: string, selector: string?): any
Returns the styled or explicitly modified value of the specified property, or else the default property value if it hasn't been styled/modified.
Parameters
Parameter Description
name: string
Name of the property to query.
selector: string?
Optional selector for the pseudo instance you are targeting on the instance.
Returns
Type Description
any
The styled or explicitly modified value of the specified property, or else the default property value if it hasn't been styled/modified.
Instance:GetStyledPropertyChangedSignal(property: string): RBXScriptSignal
Returns an event that fires when the given style property changes on the instance.
Parameters
Parameter Description
property: string
Name of the style property for which to listen for changes.
Returns
Type Description
RBXScriptSignal
Event that fires when the given style property changes.
Instance:GetTags(): { any }
Gets an array of all tags applied to the instance.
- Thread safe
- Simulation access
Returns
Type Description
{ any }
An array of strings, each representing a tag applied to the instance.
Instance:HasTag(tag: string): boolean
Check whether the instance has a given tag.
- Thread safe
- Simulation access
Parameters
Parameter Description
tag: string
The tag to check for on the instance.
Returns
Type Description
boolean
true if the instance has the given tag, false otherwise.
Instance:IsAncestorOf(descendant: Instance): boolean
Returns true if an Instance is an ancestor of the given descendant.
- Thread safe
- Simulation access
Parameters
Parameter Description
descendant: Instance
The descendant Instance.
Returns
Type Description
boolean
True if the Instance is an ancestor of the given descendant.
Instance:IsDescendantOf(ancestor: Instance): boolean
Returns true if an Instance is a descendant of the given ancestor.
- Thread safe
- Simulation access
Parameters
Parameter Description
ancestor: Instance
The ancestor Instance.
Returns
Type Description
boolean
True if the Instance is a descendant of the given ancestor.
Instance:IsPropertyModified(property: string): boolean
Returns true if the value stored in the specified property is not equal to the code-instantiated default.
- Simulation access
Parameters
Parameter Description
property: string
Name of the property to query.
Returns
Type Description
boolean
Boolean indicating whether the property is modified from its code‑instantiated default.
Instance:QueryDescendants(selector: string): { Instance }
Returns an array containing all descendants of the instance that match the selector string.
- Custom Lua state
- Simulation access
Parameters
Parameter Description
selector: string
Selector string used to filter elements.
Returns
Type Description
{ Instance }
An array of instances (empty if nothing matched the selector).
Instance:RemoveTag(tag: string)
Removes a tag from the instance.
Parameters
Parameter Description
tag: string
The tag to remove from the instance.
Instance:ResetPropertyToDefault(property: string)
Resets a property to its default value.
Parameters
Parameter Description
property: string
Name of the property to reset.
Instance:SetAttribute(attribute: string, value: any)
Sets the attribute with the given name to the given value.
- Simulation access
Parameters
Parameter Description
attribute: string
The name of the attribute being set.
value: any
The value to set the specified attribute to.
Instance:WaitForChild(childName: string, timeOut: number): Instance
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.
- Can yield
- Custom Lua state
Parameters
Parameter Description
childName: string
The Instance.Name to be looked for.
timeOut: number
An optional time out parameter.
Returns
Type Description
Instance
The Instance found.
Instance:Remove()
Deprecated: This item is deprecated in favor of Instance:Destroy() and Instance:ClearAllChildren(). If you must remove an object from the game, and wish to use the object later, set its Parent property to nil instead of using this method.
Sets the object's Parent to nil, and does the same for all its descendants.
- Deprecated
Instance:children(): { Instance }
Deprecated: This item has been superseded by Instance:GetChildren() which should be used in all new work.
Returns an array of the object's children.
- Deprecated
Returns
Type Description
{ Instance }
Array of child objects/instances.
Use GetChildren instead.
Instance:clone(): Instance
Deprecated: This deprecated function is a variant of Instance:Clone() which should be used instead.
- Deprecated
- Capabilities: CreateInstances
- Simulation access
Returns
Type
Instance
Use Clone instead.
Instance:destroy()
Deprecated: This deprecated function is a variant of Instance:Destroy() which should be used instead.
- Deprecated
Use Destroy instead.
Instance:findFirstChild(name: string, recursive: boolean? = false): Instance
Deprecated: This deprecated function is a variant of Instance:FindFirstChild() which should be used instead.
- Deprecated
- Simulation access
Parameters
Parameter
name: string
recursive: boolean? = false
Returns
Type
Instance
Use FindFirstChild instead.
Instance:getChildren(): { Instance }
Deprecated: This deprecated function is a variant of Instance:GetChildren() which should be used instead.
- Deprecated
Returns
Type
{ Instance }
Use GetChildren instead.
Instance:isDescendantOf(ancestor: Instance): boolean
Deprecated: This deprecated function is a variant of Instance:IsDescendantOf() which should be used instead.
- Deprecated
- Simulation access
Parameters
Parameter
ancestor: Instance
Returns
Type
boolean
Use IsDescendantOf instead.
Instance:remove()
Deprecated: This deprecated function is a variant of Instance:Remove() which has also been deprecated. Neither function should be used in new work.
- Deprecated
Use Remove instead.

Parameters
Parameter	Description
`tag: string`	The tag to apply to the instance.

Returns
Type	Description
`Instance`	A copy of the instance, or `nil` if the instance is not `Archivable`.

Parameters
Parameter	Description
`name: string`	The `Instance.Name` to be looked for.

Returns
Type	Description
`Instance`	The `Instance` found.

Parameters
Parameter	Description
`className: string`	The `Object.ClassName` to be looked for.

Returns
Type	Description
`Instance`	The `Instance` found.

Parameters
Parameter	Description
`className: string`	The `Object.ClassName` to be looked for.

Returns
Type	Description
`Instance`	The `Instance` found.

Parameters
Parameter	Description
`name: string`	The `Instance.Name` to be searched for.
`recursive: boolean? = false`	Whether or not the search should be conducted recursively.

Returns
Type	Description
`Instance`	The `Instance` found.

Parameters
Parameter	Description
`className: string`	The `Object.ClassName` to be looked for.

Returns
Type	Description
`Instance`	The `Instance` found.

Parameters
Parameter	Description
`className: string`	The `Object.ClassName` to be searched for.
`recursive: boolean? = false`	Whether or not the search should be conducted recursively.

Returns
Type	Description
`Instance`	The `Instance` found.

Parameters
Parameter	Description
`name: string`	The `Instance.Name` to search for.

Returns
Type	Description
`Instance`	The `Instance` found.

Returns
Type	Description
`Actor`	The `Actor` found.

Parameters
Parameter	Description
`attribute: string`	The name of the attribute being retrieved.

Returns
Type	Description
`any`	The value which has been assigned to the given attribute name. If no attribute has been assigned, `nil` is returned.

Parameters
Parameter	Description
`attribute: string`	The name of the specified attribute for which the change signal is being returned.

Returns
Type	Description
`RBXScriptSignal`	An event that fires when the given attribute changes.

Returns
Type	Description
`{ [string]: any }`	A dictionary of string → variant pairs for each attribute where the string is the name of the attribute and the variant is a non-nil value.

Returns
Type	Description
`{ Instance }`	An array containing the instance's children.

Parameters
Parameter	Description
`scopeLength: number? = 4`	The scope length.

Returns
Type	Description
`string`	The Debug ID string.

Returns
Type	Description
`{ Instance }`	An array containing the instance's descendants.

Returns
Type	Description
`string`	The full name of the `Instance`.

Parameters
Parameter	Description
`name: string`	Name of the property to query.
`selector: string?`	Optional selector for the pseudo instance you are targeting on the instance.

Returns
Type	Description
`any`	The styled or explicitly modified value of the specified property, or else the default property value if it hasn't been styled/modified.

Parameters
Parameter	Description
`property: string`	Name of the style property for which to listen for changes.

Returns
Type	Description
`RBXScriptSignal`	Event that fires when the given style property changes.

Returns
Type	Description
`{ any }`	An array of strings, each representing a tag applied to the instance.

Parameters
Parameter	Description
`tag: string`	The tag to check for on the instance.

Returns
Type	Description
`boolean`	`true` if the instance has the given tag, `false` otherwise.

Parameters
Parameter	Description
`descendant: Instance`	The descendant `Instance`.

Returns
Type	Description
`boolean`	True if the `Instance` is an ancestor of the given descendant.

Parameters
Parameter	Description
`ancestor: Instance`	The ancestor `Instance`.

Returns
Type	Description
`boolean`	True if the `Instance` is a descendant of the given ancestor.

Parameters
Parameter	Description
`property: string`	Name of the property to query.

Returns
Type	Description
`boolean`	Boolean indicating whether the property is modified from its code‑instantiated default.

Parameters
Parameter	Description
`selector: string`	Selector string used to filter elements.

Returns
Type	Description
`{ Instance }`	An array of instances (empty if nothing matched the selector).

Parameters
Parameter	Description
`tag: string`	The tag to remove from the instance.

Parameters
Parameter	Description
`property: string`	Name of the property to reset.

Defined byGuiService64

GuiService:AddCenterDialog(dialog: Instance,centerDialogType: Enum.CenterDialogType,showFunction: (...any) -> ...any,hideFunction: (...any) -> ...any,)
- Roblox script security
- Capabilities: UI
Parameters
Parameter
dialog: Instance
centerDialogType: Enum.CenterDialogType
showFunction: (...any) -> ...any
hideFunction: (...any) -> ...any
GuiService:AddKey(key: string)
- Roblox script security
- Capabilities: UI
Parameters
Parameter
key: string
GuiService:AddSpecialKey(key: Enum.SpecialKey)
- Roblox script security
- Capabilities: UI
Parameters
Parameter
key: Enum.SpecialKey
GuiService:BroadcastNotification(data: string, notificationType: number)
- Roblox script security
- Capabilities: UI
Parameters
Parameter
data: string
notificationType: number
GuiService:ClearError()
- Roblox script security
- Capabilities: UI
GuiService:CloseInspectMenu()
Closes the avatar inspection menu, if open.
- Capabilities: UI
GuiService:CloseStatsBasedOnInputString(input: string): boolean
- Roblox script security
- Capabilities: UI
Parameters
Parameter
input: string
Returns
Type
boolean
GuiService:DismissNotification(notificationId: string): boolean
Dismisses a notification previously shown by SendNotification().
- Capabilities: UI
Parameters
Parameter Description
notificationId: string
The identifier returned by SendNotification() for the notification to dismiss.
Returns
Type Description
boolean
true if a matching notification was found and dismissed; false if no active notification has the given notificationId.
GuiService:ForceTenFootInterface(isForced: boolean)
- Roblox script security
- Capabilities: UI
Parameters
Parameter
isForced: boolean
GuiService:GetAutoUIScaleHundredths(): number
- Roblox script security
- Capabilities: UI
Returns
Type
number
GuiService:GetBrickCount(): number
- Roblox script security
- Capabilities: UI
Returns
Type
number
GuiService:GetClosestDialogToPosition(position: Vector3): Instance
- Roblox script security
- Capabilities: UI
Parameters
Parameter
position: Vector3
Returns
Type
Instance
GuiService:GetClosestVisibleDialogToPosition(position: Vector3): Dialog
- Roblox script security
- Capabilities: UI
Parameters
Parameter
position: Vector3
Returns
Type
Dialog
GuiService:GetEffectiveUIScaleHundredths(): number
- Roblox script security
- Capabilities: UI
Returns
Type
number
GuiService:GetEmotesMenuOpen(): boolean
Checks if the player emotes menu is open.
- Capabilities: UI
Returns
Type Description
boolean
Whether the emotes menu is open.
GuiService:GetErrorCode(): Enum.ConnectionError
- Roblox script security
- Capabilities: UI
Returns
Type
Enum.ConnectionError
GuiService:GetErrorDetails(): { [string]: any }
- Roblox script security
- Capabilities: UI
Returns
Type
{ [string]: any }
GuiService:GetErrorType(): Enum.ConnectionError
- Roblox script security
- Capabilities: UI
Returns
Type
Enum.ConnectionError
GuiService:GetGameplayPausedNotificationEnabled(): boolean
Returns whether or not the Player.GameplayPaused notification has been disabled.
- Capabilities: UI
Returns
Type Description
boolean
Whether or not the Player.GameplayPaused notification has been disabled.
GuiService:GetGuiInset(): ...any
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.
- Capabilities: UI
Returns
Type Description
...any
A tuple of two Vector2 values describing the current specified GUI inset.
GuiService:GetGuiIsVisible(guiType: Enum.GuiType): boolean
- Roblox script security
- Capabilities: UI
Parameters
Parameter
guiType: Enum.GuiType
Returns
Type
boolean
GuiService:GetHardwareSafeViewport(): Vector2
- Roblox script security
- Capabilities: UI
Returns
Type
Vector2
GuiService:GetInsetArea(screenInsets: Enum.ScreenInsets): Rect
Takes an ScreenInsets value and returns a Rect describing the inset region, relative to the CoreUISafeInsets area.
- Capabilities: UI
Parameters
Parameter Description
screenInsets: Enum.ScreenInsets
The ScreenInsets value indicating which inset area to query.
Returns
Type Description
Rect
A Rect of the usable region for the specified ScreenInsets area.
GuiService:GetInspectMenuEnabled(): boolean
Returns whether the avatar inspection menu is enabled.
- Capabilities: UI
Returns
Type Description
boolean
Whether the avatar inspection menu is enabled.
GuiService:GetNotificationTypeList(): { [string]: any }
- Roblox script security
- Capabilities: UI
Returns
Type
{ [string]: any }
GuiService:GetRawScreenScale(): number
- Roblox script security
- Capabilities: UI
Returns
Type
number
GuiService:GetResolutionScale(): number
- Roblox script security
- Capabilities: UI
Returns
Type
number
GuiService:GetSafeZoneOffsets(): { [string]: any }
- Roblox script security
- Capabilities: UI
Returns
Type
{ [string]: any }
GuiService:GetScreenResolution(): Vector2
- Yields
- Roblox script security
- Capabilities: UI
Returns
Type
Vector2
GuiService:GetUiMessage(): string
- Roblox script security
- Capabilities: UI
Returns
Type
string

GuiService:InspectPlayerFromHumanoidDescription(humanoidDescription: Instance,name: string,)

Allows the avatar inspection menu to appear showing the assets listed in a HumanoidDescription object.

Parameters
Parameter	Description
`humanoidDescription: Instance`	A `HumanoidDescription` object that contains the assets to show in the inspection menu.
`name: string`	The name of the player being inspected to show in the menu.

GuiService:InspectPlayerFromUserId(userId: User)
Allows the avatar inspection menu to appear showing the user that has the given UserId.
- Capabilities: AvatarAppearance + UI
Parameters
Parameter Description
userId: User
The UserId of the player to inspect.
GuiService:InspectPlayerFromUserIdWithCtx(userId: User, ctx: string)
- Roblox script security
- Capabilities: UI
Parameters
Parameter
userId: User
ctx: string
GuiService:IsMemoryTrackerEnabled(): boolean
- Roblox script security
- Capabilities: UI
Returns
Type
boolean
GuiService:IsTenFootInterface(): boolean
Returns true if the client is using the ten foot interface, a special version of Roblox's UI exclusive to consoles.
- Capabilities: UI
Returns
Type Description
boolean
true if the client is using the ten foot interface (console UI mode); false otherwise.
GuiService:OnNotificationDisplayed(notificationId: string)
- Roblox script security
- Capabilities: UI
Parameters
Parameter
notificationId: string
GuiService:OnNotificationInteraction(notificationId: string,buttonIndex: number,)
- Roblox script security
- Capabilities: UI
Parameters
Parameter
notificationId: string
buttonIndex: number
GuiService:RemoveCenterDialog(dialog: Instance)
- Roblox script security
- Capabilities: UI
Parameters
Parameter
dialog: Instance
GuiService:RemoveKey(key: string)
- Roblox script security
- Capabilities: UI
Parameters
Parameter
key: string
GuiService:RemoveSpecialKey(key: Enum.SpecialKey)
- Roblox script security
- Capabilities: UI
Parameters
Parameter
key: Enum.SpecialKey
GuiService:Select(selectionParent: Instance)
Sets GuiService.SelectedObject to a child of a provided instance that is the PlayerGui or its descendants.
- Capabilities: UI
Parameters
Parameter Description
selectionParent: Instance
The parent of selection whose descendants are searched.

GuiService:SendNotification(notificationInfo: { [string]: any }): string

Displays a notification described by notificationInfo and returns a unique identifier for it.

Parameters
Parameter	Description
`notificationInfo: { [string]: any }`	A dictionary describing the notification. Recognized fields are `Title` (string), `Text` (string), `Icon` (string), `Buttons` (an array of button tables, each with a `Text` string, a `ButtonTypeNotificationButtonType` value, and an `OnActivated` callback), and `OnDisplay`/`OnDismiss` callback functions.

Returns
Type	Description
`string`	A unique identifier string for the notification, which can be passed to `DismissNotification()`. Returns an empty string if the notification could not be queued.

GuiService:SendUIOcclusionMetricsForQueryRegion(position: UDim2,size: UDim2,regionName: string,)
- Roblox script security
- Capabilities: UI
Parameters
Parameter
position: UDim2
size: UDim2
regionName: string
GuiService:SetEmotesMenuOpen(isOpen: boolean)
Opens or closes the player emotes menu.
- Capabilities: UI
Parameters
Parameter Description
isOpen: boolean
Whether to open (true) or close (false) the emotes menu.
GuiService:SetGameplayPausedNotificationEnabled(enabled: boolean)
Lets you disable the built-in notification when a player's gameplay is paused.
- Capabilities: UI
Parameters
Parameter Description
enabled: boolean
Whether or not the built-in notification GUI is disabled.
GuiService:SetGlobalGuiInset(x1: number, y1: number, x2: number, y2: number)
- Roblox script security
- Capabilities: UI
Parameters
Parameter
x1: number
y1: number
x2: number
y2: number
GuiService:SetHardwareSafeAreaInsets(left: number,top: number,right: number,bottom: number,)
- Roblox script security
- Capabilities: UI
Parameters
Parameter
left: number
top: number
right: number
bottom: number
GuiService:SetInspectMenuEnabled(enabled: boolean)
Allows you to enable or disable the avatar inspection menu.
- Capabilities: UI
Parameters
Parameter Description
enabled: boolean
A boolean indicating whether to enable or disable the menu.
GuiService:SetMenuIsOpen(open: boolean, menuName: string? = "default")
- Roblox script security
- Capabilities: UI
Parameters
Parameter
open: boolean
menuName: string? = "default"
GuiService:SetPurchasePromptIsShown(isShown: boolean)
- Roblox script security
- Capabilities: UI
Parameters
Parameter
isShown: boolean
GuiService:SetSafeZoneOffsets(top: number,bottom: number,left: number,right: number,)
- Roblox script security
- Capabilities: UI
Parameters
Parameter
top: number
bottom: number
left: number
right: number
GuiService:SetTopbarInset(topbarInset: Rect)
- Roblox script security
- Capabilities: UI
Parameters
Parameter
topbarInset: Rect
GuiService:SetUiMessage(msgType: Enum.UiMessageType,uiMessage: string? = "errorCode",)
- Local user security
- Capabilities: UI
Parameters
Parameter
msgType: Enum.UiMessageType
uiMessage: string? = "errorCode"
GuiService:SetUIScaleMultiplier(multiplierHundredths: number)
- Roblox script security
- Capabilities: UI
Parameters
Parameter
multiplierHundredths: number
GuiService:ShowStatsBasedOnInputString(input: string): boolean
- Roblox script security
- Capabilities: UI
Parameters
Parameter
input: string
Returns
Type
boolean
GuiService:ToggleFullscreen()
- Roblox script security
- Capabilities: UI
GuiService:ToggleGuiIsVisibleForCaptures(guiType: Enum.GuiType)
- Roblox script security
- Capabilities: UI
Parameters
Parameter
guiType: Enum.GuiType
GuiService:ToggleGuiIsVisibleIfAllowed(guiType: Enum.GuiType)
- Roblox script security
- Capabilities: UI
Parameters
Parameter
guiType: Enum.GuiType
GuiService:AddSelectionParent(selectionName: string, selectionParent: Instance)
Deprecated:
Creates a selection group where gamepad GUI navigation will only consider selectable objects that are within the group.
- Deprecated
- Capabilities: UI
Parameters
Parameter Description
selectionName: string
A unique name identifying this selection group.
selectionParent: Instance
The GuiObject whose selectable descendants form the navigation group.
Use SelectionGroup instead.
GuiService:AddSelectionTuple(selectionName: string, ...: any)
Deprecated:
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/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))
```
- Deprecated
- Capabilities: UI
Parameters
Parameter Description
selectionName: string
The name of the added selection.
...: any
The selection(s) added.
Use SelectionGroup instead.
GuiService:GetErrorMessage(): string
- Deprecated
- Roblox script security
- Capabilities: UI
Returns
Type
string
Use GetUiMessage instead.
GuiService:OpenBrowserWindow(url: string)
- Deprecated
- Roblox script security
- Capabilities: UI
Parameters
Parameter
url: string
GuiService:OpenNativeOverlay(title: string, url: string)
- Deprecated
- Roblox script security
- Capabilities: UI
Parameters
Parameter
title: string
url: string
GuiService:RemoveSelectionGroup(selectionName: string)
Deprecated:
Removes a group that was created with AddSelectionParent() or AddSelectionTuple().
- Deprecated
- Capabilities: UI
Parameters
Parameter Description
selectionName: string
The name of the selection group to remove.
Use SelectionGroup instead.

Events32

Inherited fromObject1

Object.Changed: RBXScriptSignal<(property: string)>
Fires immediately after a property of the object changes, with some limitations.
Parameters
Parameter
property: string

Inherited fromInstance9

Instance.AncestryChanged: RBXScriptSignal<(child: Instance, parent: Instance)>
Fires when the Instance.Parent property of this object or one of its ancestors is changed.
Parameters
Parameter
child: Instance
parent: Instance
Instance.AttributeChanged: RBXScriptSignal<(attribute: string)>
Fires whenever an attribute is changed on the Instance.
Parameters
Parameter
attribute: string
Instance.ChildAdded: RBXScriptSignal<(child: Instance)>
Fires after an object is parented to this Instance.
Parameters
Parameter
child: Instance
Instance.ChildRemoved: RBXScriptSignal<(child: Instance)>
Fires after a child is removed from this Instance.
Parameters
Parameter
child: Instance
Instance.DescendantAdded: RBXScriptSignal<(descendant: Instance)>
Fires after a descendant is added to the Instance.
Parameters
Parameter
descendant: Instance
Instance.DescendantRemoving: RBXScriptSignal<(descendant: Instance)>
Fires immediately before a descendant of the Instance is removed.
Parameters
Parameter
descendant: Instance
Instance.Destroying: RBXScriptSignal<()>
Fires immediately before (or is deferred until after) the instance is destroyed via Instance:Destroy().
Instance.StyledPropertiesChanged: RBXScriptSignal<()>
Fires whenever any style property is changed on the instance, including when a property is set to nil.
Instance.childAdded: RBXScriptSignal<(child: Instance)>
Deprecated: This deprecated event is a variant of Instance.ChildAdded which should be used instead.
- Deprecated
Parameters
Parameter
child: Instance
Use ChildAdded instead.

Defined byGuiService22

GuiService.CloseInspectMenuRequest: RBXScriptSignal<()>
- Roblox script security
- Capabilities: UI
GuiService.CoreGuiRenderOverflowed: RBXScriptSignal<()>
- Roblox script security
- Capabilities: UI
GuiService.EmotesMenuOpenChanged: RBXScriptSignal<(isOpen: boolean)>
- Roblox script security
- Capabilities: UI
Parameters
Parameter
isOpen: boolean
GuiService.GuiVisibilityChangedSignal: RBXScriptSignal<(guiType: Enum.GuiType,visible: boolean,)>
- Roblox script security
- Capabilities: UI
Parameters
Parameter
guiType: Enum.GuiType
visible: boolean
GuiService.InspectMenuEnabledChangedSignal: RBXScriptSignal<(enabled: boolean)>
- Roblox script security
- Capabilities: UI
Parameters
Parameter
enabled: boolean
GuiService.InspectPlayerFromHumanoidDescriptionRequest: RBXScriptSignal<(humanoidDescription: Instance,name: string,)>
- Roblox script security
- Capabilities: UI
Parameters
Parameter
humanoidDescription: Instance
name: string
GuiService.InspectPlayerFromUserIdWithCtxRequest: RBXScriptSignal<(userId: number,ctx: string,)>
- Roblox script security
- Capabilities: UI
Parameters
Parameter
userId: number
ctx: string
GuiService.KeyPressed: RBXScriptSignal<(key: string, modifiers: string)>
- Roblox script security
- Capabilities: UI
Parameters
Parameter
key: string
modifiers: string
GuiService.MenuClosed: RBXScriptSignal<()>
Fires when the user closes the Roblox CoreGui escape menu.
- Capabilities: UI
GuiService.MenuOpened: RBXScriptSignal<()>
Fires when the user opens the Roblox CoreGui escape menu.
- Capabilities: UI
GuiService.NativeClose: RBXScriptSignal<()>
- Roblox script security
- Capabilities: UI
GuiService.NetworkPausedEnabledChanged: RBXScriptSignal<(enabled: boolean)>
- Roblox script security
- Capabilities: UI
Parameters
Parameter
enabled: boolean
GuiService.Open9SliceEditor: RBXScriptSignal<(selectedImageObject: Instance)>
- Roblox script security
- Capabilities: UI
Parameters
Parameter
selectedImageObject: Instance
GuiService.OpenStyleEditor: RBXScriptSignal<(styleBase: Instance)>
- Roblox script security
- Capabilities: UI
Parameters
Parameter
styleBase: Instance
GuiService.PurchasePromptShown: RBXScriptSignal<()>
- Roblox script security
- Capabilities: UI
GuiService.SafeZoneOffsetsChanged: RBXScriptSignal<()>
- Roblox script security
- Capabilities: UI
GuiService.ScrollStateChanged: RBXScriptSignal<(scrollingFrame: Instance,newState: Enum.ScrollState,)>
- Roblox script security
- Capabilities: UI
Parameters
Parameter
scrollingFrame: Instance
newState: Enum.ScrollState
GuiService.ShowLeaveConfirmation: RBXScriptSignal<()>
- Roblox script security
- Capabilities: UI
GuiService.SpecialKeyPressed: RBXScriptSignal<(key: Enum.SpecialKey,modifiers: string,)>
- Roblox script security
- Capabilities: UI
Parameters
Parameter
key: Enum.SpecialKey
modifiers: string
GuiService.UiMessageChanged: RBXScriptSignal<(msgType: Enum.UiMessageType,newUiMessage: string,)>
- Roblox script security
- Capabilities: UI
Parameters
Parameter
msgType: Enum.UiMessageType
newUiMessage: string
GuiService.BrowserWindowClosed: RBXScriptSignal<()>
- Deprecated
- Roblox script security
- Capabilities: UI
GuiService.ErrorMessageChanged: RBXScriptSignal<(newErrorMessage: string)>
- Deprecated
- Roblox script security
- Capabilities: UI
Parameters
Parameter
newErrorMessage: string
Use UiMessageChanged instead.

Callbacks1

Defined byGuiService1

GuiService.SendCoreUiNotification: (title: string, text: string) -> ()
- Roblox script security
- Capabilities: UI
Parameters
Parameter
title: string
text: string