Reference API Roblox

Engine API

Website

Related

Reference API Roblox

GuiService

Summary

This class is not replicated. Its interface does not cross the network boundary.
This class is not creatable. Instances of this class cannot be created with Instance.new.
This class is a service. It is a singleton that may be acquired with GetService.
Tags: [NotCreatable, Service, NotReplicated]

Member index 89

HistoryMember
553AutoSelectGuiEnabled: bool
553GuiNavigationEnabled: bool
553IsModalDialog: bool
553IsWindows: bool
553MenuIsOpen: bool
553SelectedObject: GuiObject
599TopbarInset: Rect
553TouchControlsEnabled: bool
573AddCenterDialog(dialog: Instance, centerDialogType: CenterDialogType, showFunction: Function, hideFunction: Function): null
573AddKey(key: string): null
573AddSelectionParent(selectionName: string, selectionParent: Instance): null
573AddSelectionTuple(selectionName: string, selections: Tuple): null
573AddSpecialKey(key: SpecialKey): null
573BroadcastNotification(data: string, notificationType: int): null
573ClearError(): null
573CloseInspectMenu(): null
462CloseStatsBasedOnInputString(input: string): bool
573ForceTenFootInterface(isForced: bool): null
462GetBrickCount(): int
462GetClosestDialogToPosition(position: Vector3): Instance
462GetEmotesMenuOpen(): bool
462GetErrorCode(): ConnectionError
553GetErrorMessage(): string
462GetErrorType(): ConnectionError
462GetGameplayPausedNotificationEnabled(): bool
462GetGuiInset(): Tuple
538GetGuiIsVisible(guiType: GuiType): bool
592GetHardwareSafeViewport(): Vector2
462GetInspectMenuEnabled(): bool
462GetNotificationTypeList(): Dictionary
462GetResolutionScale(): int
462GetSafeZoneOffsets(): Dictionary
462GetScreenResolution(): Vector2
462GetUiMessage(): string
573InspectPlayerFromHumanoidDescription(humanoidDescription: Instance, name: string): null
573InspectPlayerFromUserId(userId: int64): null
573InspectPlayerFromUserIdWithCtx(userId: int64, ctx: string): null
462IsMemoryTrackerEnabled(): bool
462IsTenFootInterface(): bool
573OpenBrowserWindow(url: string): null
573OpenNativeOverlay(title: string, url: string): null
573RemoveCenterDialog(dialog: Instance): null
573RemoveKey(key: string): null
573RemoveSelectionGroup(selectionName: string): null
573RemoveSpecialKey(key: SpecialKey): null
573Select(selectionParent: Instance): null
598SendUIOcclusionMetricsForQueryRegion(position: UDim2, size: UDim2, regionName: string): null
573SetEmotesMenuOpen(isOpen: bool): null
573SetGameplayPausedNotificationEnabled(enabled: bool): null
573SetGlobalGuiInset(x1: int, y1: int, x2: int, y2: int): null
573SetHardwareSafeAreaInsets(left: float, top: float, right: float, bottom: float): null
573SetInspectMenuEnabled(enabled: bool): null
573SetMenuIsOpen(open: bool, menuName: string = default): null
573SetPurchasePromptIsShown(isShown: bool): null
573SetSafeZoneOffsets(top: float, bottom: float, left: float, right: float): null
591SetTopbarInset(topbarInset: Rect): null
573SetUiMessage(msgType: UiMessageType, uiMessage: string = errorCode): null
462ShowStatsBasedOnInputString(input: string): bool
573ToggleFullscreen(): null
587ToggleGuiIsVisibleForCaptures(guiType: GuiType): null
573ToggleGuiIsVisibleIfAllowed(guiType: GuiType): null
462BrowserWindowClosed()
462CloseInspectMenuRequest()
489CoreGuiRenderOverflowed()
462EmotesMenuOpenChanged(isOpen: bool)
553ErrorMessageChanged(newErrorMessage: string)
538GuiVisibilityChangedSignal(guiType: GuiType, visible: bool)
462InspectMenuEnabledChangedSignal(enabled: bool)
462InspectPlayerFromHumanoidDescriptionRequest(humanoidDescription: Instance, name: string)
462InspectPlayerFromUserIdWithCtxRequest(userId: int64, ctx: string)
462KeyPressed(key: string, modifiers: string)
462MenuClosed()
462MenuOpened()
462NativeClose()
462NetworkPausedEnabledChanged(enabled: bool)
487Open9SliceEditor(selectedImageObject: Instance)
624OpenAttenuationCurveEditor(selectedCurveObjects: Objects)
561PurchasePromptShown()
462SafeZoneOffsetsChanged()
462ShowLeaveConfirmation()
462SpecialKeyPressed(key: SpecialKey, modifiers: string)
462UiMessageChanged(msgType: UiMessageType, newUiMessage: string)
573SendCoreUiNotification(title: string, text: string): null
inherited from Instance
553Archivable: bool
619Capabilities: SecurityCapabilities
553ClassName: string
553Name: string
553Parent: Instance
619Sandboxed: bool
616UniqueId: UniqueId
553className: string
576AddTag(tag: string): null
573ClearAllChildren(): null
462Clone(): Instance
573Destroy(): null
486FindFirstAncestor(name: string): Instance
486FindFirstAncestorOfClass(className: string): Instance
486FindFirstAncestorWhichIsA(className: string): Instance
486FindFirstChild(name: string, recursive: bool = false): Instance
486FindFirstChildOfClass(className: string): Instance
486FindFirstChildWhichIsA(className: string, recursive: bool = false): Instance
486FindFirstDescendant(name: string): Instance
563GetActor(): Actor
486GetAttribute(attribute: string): Variant
462GetAttributeChangedSignal(attribute: string): RBXScriptSignal
486GetAttributes(): Dictionary
486GetChildren(): Objects
462GetDebugId(scopeLength: int = 4): string
486GetDescendants(): Array
486GetFullName(): string
462GetPropertyChangedSignal(property: string): RBXScriptSignal
576GetTags(): Array
576HasTag(tag: string): bool
486IsA(className: string): bool
486IsAncestorOf(descendant: Instance): bool
486IsDescendantOf(ancestor: Instance): bool
580IsPropertyModified(name: string): bool
573Remove(): null
576RemoveTag(tag: string): null
580ResetPropertyToDefault(name: string): null
573SetAttribute(attribute: string, value: Variant): null
462WaitForChild(childName: string, timeOut: double): Instance
553children(): Objects
553clone(): Instance
573destroy(): null
553findFirstChild(name: string, recursive: bool = false): Instance
553getChildren(): Objects
462isA(className: string): bool
553isDescendantOf(ancestor: Instance): bool
573remove(): null
462AncestryChanged(child: Instance, parent: Instance)
462AttributeChanged(attribute: string)
462Changed(property: string)
462ChildAdded(child: Instance)
462ChildRemoved(child: Instance)
462DescendantAdded(descendant: Instance)
462DescendantRemoving(descendant: Instance)
500Destroying()
553childAdded(child: Instance)

Removed member index 18

HistoryMember
201GamepadNavigationEnabled: bool
304ScreenGuiEnabled: bool
213ShowLegacyPlayerList: bool
213UseLuaChat: bool
213Version: double
213GetConnectorCount(): int
213GetInstanceCount(): int
303GetNativeViewFeatureList(): Dictionary
213GetVoxelCount(): float
303RequestNativeView(url: string, featureType: int): void
190SendNotification(title: string, text: string, image: string, duration: int, callback: Function): void
273SetErrorMessage(errorMessage: string): void
91SetGlobalSizeOffsetPixel(x: int, y: int): void
303ShowAppShellTabBar(value: bool): void
304EscapeKeyPressed()
420InspectPlayerFromUserIdRequest(userId: int64)
591TopbarInsetChanged(topbarInset: Dictionary)

History 294

Members 89

AddCenterDialog

Parameters (4)
dialogInstance
centerDialogTypeCenterDialogType
showFunctionFunction
hideFunctionFunction
Returns (1)
null

History 3

AddKey

Parameters (1)
keystring
Returns (1)
null

History 3

AddSelectionParent

Parameters (2)
selectionNamestring
selectionParentInstance
Returns (1)
null

History 3

AddSelectionTuple

Parameters (2)
selectionNamestring
selectionsTuple
Returns (1)
null

History 3

AddSpecialKey

Parameters (1)
keySpecialKey
Returns (1)
null

History 3

AutoSelectGuiEnabled

TypeDefault
bool

History 4

BroadcastNotification

Parameters (2)
datastring
notificationTypeint
Returns (1)
null

History 3

BrowserWindowClosed

Parameters (0)
No parameters.
This event is deprecated. It exists only for backward compatibility, and should not be used for new work.

History 3

Tags: [Deprecated]

ClearError

Parameters (0)
No parameters.
Returns (1)
null

History 3

CloseInspectMenu

Parameters (0)
No parameters.
Returns (1)
null

History 3

CloseInspectMenuRequest

Parameters (0)
No parameters.

History 2

CloseStatsBasedOnInputString

Parameters (1)
inputstring
Returns (1)
bool

History 2

CoreGuiRenderOverflowed

Parameters (0)
No parameters.

History 3

EmotesMenuOpenChanged

Parameters (1)
isOpenbool

History 2

ErrorMessageChanged

Parameters (1)
newErrorMessagestring
This event is deprecated. It exists only for backward compatibility, and should not be used for new work. UiMessageChanged should be used instead.

History 4

Tags: [Deprecated]

ForceTenFootInterface

Parameters (1)
isForcedbool
Returns (1)
null

History 3

GetBrickCount

Parameters (0)
No parameters.
Returns (1)
int

History 2

GetClosestDialogToPosition

Parameters (1)
positionVector3
Returns (1)
Instance

History 2

GetEmotesMenuOpen

Parameters (0)
No parameters.
Returns (1)
bool

History 2

GetErrorCode

Parameters (0)
No parameters.
Returns (1)
ConnectionError

History 2

GetErrorMessage

Parameters (0)
No parameters.
Returns (1)
string
This function is deprecated. It exists only for backward compatibility, and should not be used for new work. GetUiMessage should be used instead.

History 4

Tags: [Deprecated]

GetErrorType

Parameters (0)
No parameters.
Returns (1)
ConnectionError

History 2

GetGameplayPausedNotificationEnabled

Parameters (0)
No parameters.
Returns (1)
bool

History 2

GetGuiInset

Parameters (0)
No parameters.
Returns (1)
Tuple

History 2

GetGuiIsVisible

Parameters (1)
guiTypeGuiType
Returns (1)
bool

History 1

GetHardwareSafeViewport

Parameters (0)
No parameters.
Returns (1)
Vector2

History 1

GetInspectMenuEnabled

Parameters (0)
No parameters.
Returns (1)
bool

History 2

GetNotificationTypeList

Parameters (0)
No parameters.
Returns (1)
Dictionary

History 2

GetResolutionScale

Parameters (0)
No parameters.
Returns (1)
int

History 3

GetSafeZoneOffsets

Parameters (0)
No parameters.
Returns (1)
Dictionary

History 2

GetScreenResolution

Parameters (0)
No parameters.
Returns (1)
Vector2
This function yields. It will block the calling thread until completion.

History 2

Tags: [Yields]

GetUiMessage

Parameters (0)
No parameters.
Returns (1)
string

History 2

GuiNavigationEnabled

TypeDefault
bool

History 4

GuiVisibilityChangedSignal

Parameters (2)
guiTypeGuiType
visiblebool

History 1

InspectMenuEnabledChangedSignal

Parameters (1)
enabledbool

History 2

InspectPlayerFromHumanoidDescription

Parameters (2)
humanoidDescriptionInstance
namestring
Returns (1)
null

History 3

InspectPlayerFromHumanoidDescriptionRequest

Parameters (2)
humanoidDescriptionInstance
namestring

History 2

InspectPlayerFromUserId

Parameters (1)
userIdint64
Returns (1)
null

History 3

InspectPlayerFromUserIdWithCtx

Parameters (2)
userIdint64
ctxstring
Returns (1)
null

History 3

InspectPlayerFromUserIdWithCtxRequest

Parameters (2)
userIdint64
ctxstring

History 2

IsMemoryTrackerEnabled

Parameters (0)
No parameters.
Returns (1)
bool

History 2

IsModalDialog

TypeDefault
bool
This property is deprecated. It exists only for backward compatibility, and should not be used for new work.
This property is not replicated. Its interface does not cross the network boundary.
This property is read-only. Its value can be read, but it cannot be modified.

History 5

Tags: [ReadOnly, NotReplicated, Deprecated]

IsTenFootInterface

Parameters (0)
No parameters.
Returns (1)
bool

History 3

IsWindows

TypeDefault
bool
This property is deprecated. It exists only for backward compatibility, and should not be used for new work.
This property is not replicated. Its interface does not cross the network boundary.
This property is read-only. Its value can be read, but it cannot be modified.

History 5

Tags: [ReadOnly, NotReplicated, Deprecated]

KeyPressed

Parameters (2)
keystring
modifiersstring

History 2

MenuClosed

Parameters (0)
No parameters.

History 2

MenuIsOpen

TypeDefault
bool
This property is not replicated. Its interface does not cross the network boundary.
This property is read-only. Its value can be read, but it cannot be modified.

History 4

Tags: [ReadOnly, NotReplicated]

MenuOpened

Parameters (0)
No parameters.

History 2

NativeClose

Parameters (0)
No parameters.

History 2

NetworkPausedEnabledChanged

Parameters (1)
enabledbool

History 2

Open9SliceEditor

Parameters (1)
selectedImageObjectInstance

History 1

OpenAttenuationCurveEditor

Parameters (1)
selectedCurveObjectsObjects

History 2

OpenBrowserWindow

Parameters (1)
urlstring
Returns (1)
null
This function is deprecated. It exists only for backward compatibility, and should not be used for new work.

History 4

Tags: [Deprecated]

OpenNativeOverlay

Parameters (2)
titlestring
urlstring
Returns (1)
null
This function is deprecated. It exists only for backward compatibility, and should not be used for new work.

History 4

Tags: [Deprecated]

PurchasePromptShown

Parameters (0)
No parameters.

History 1

RemoveCenterDialog

Parameters (1)
dialogInstance
Returns (1)
null

History 3

RemoveKey

Parameters (1)
keystring
Returns (1)
null

History 3

RemoveSelectionGroup

Parameters (1)
selectionNamestring
Returns (1)
null

History 3

RemoveSpecialKey

Parameters (1)
keySpecialKey
Returns (1)
null

History 3

SafeZoneOffsetsChanged

Parameters (0)
No parameters.

History 2

Select

Parameters (1)
selectionParentInstance
Returns (1)
null

History 3

SelectedObject

TypeDefault
GuiObject

History 7

SendCoreUiNotification

Parameters (2)
titlestring
textstring
Returns (1)
null

History 3

SendUIOcclusionMetricsForQueryRegion

Parameters (3)
positionUDim2
sizeUDim2
regionNamestring
Returns (1)
null

History 1

SetEmotesMenuOpen

Parameters (1)
isOpenbool
Returns (1)
null

History 3

SetGameplayPausedNotificationEnabled

Parameters (1)
enabledbool
Returns (1)
null

History 3

SetGlobalGuiInset

Parameters (4)
x1int
y1int
x2int
y2int
Returns (1)
null

History 5

SetHardwareSafeAreaInsets

Parameters (4)
leftfloat
topfloat
rightfloat
bottomfloat
Returns (1)
null

History 2

SetInspectMenuEnabled

Parameters (1)
enabledbool
Returns (1)
null

History 3

SetMenuIsOpen

Parameters (2)Default
openbool
menuNamestringdefault
Returns (1)
null

History 4

SetPurchasePromptIsShown

Parameters (1)
isShownbool
Returns (1)
null

History 2

SetSafeZoneOffsets

Parameters (4)
topfloat
bottomfloat
leftfloat
rightfloat
Returns (1)
null

History 3

SetTopbarInset

Parameters (1)
topbarInsetRect
Returns (1)
null

History 2

SetUiMessage

Parameters (2)Default
msgTypeUiMessageType
uiMessagestringerrorCode
Returns (1)
null

History 4

ShowLeaveConfirmation

Parameters (0)
No parameters.

History 2

ShowStatsBasedOnInputString

Parameters (1)
inputstring
Returns (1)
bool

History 2

SpecialKeyPressed

Parameters (2)
keySpecialKey
modifiersstring

History 2

ToggleFullscreen

Parameters (0)
No parameters.
Returns (1)
null

History 3

ToggleGuiIsVisibleForCaptures

Parameters (1)
guiTypeGuiType
Returns (1)
null

History 1

ToggleGuiIsVisibleIfAllowed

Parameters (1)
guiTypeGuiType
Returns (1)
null

History 2

TopbarInset

TypeDefault
Rect
This property is not replicated. Its interface does not cross the network boundary.
This property is read-only. Its value can be read, but it cannot be modified.

History 2

Tags: [ReadOnly, NotReplicated]

TouchControlsEnabled

TypeDefault
bool

History 2

UiMessageChanged

Parameters (2)
msgTypeUiMessageType
newUiMessagestring

History 2

Removed members 18

EscapeKeyPressed

Parameters (0)
No parameters.

History 2

GamepadNavigationEnabled

TypeDefault
bool

History 2

GetConnectorCount

Parameters (0)
No parameters.
Returns (1)
int

History 2

GetInstanceCount

Parameters (0)
No parameters.
Returns (1)
int

History 2

GetNativeViewFeatureList

Parameters (0)
No parameters.
Returns (1)
Dictionary

History 2

GetVoxelCount

Parameters (0)
No parameters.
Returns (1)
float

History 3

InspectPlayerFromUserIdRequest

Parameters (1)
userIdint64

History 4

RequestNativeView

Parameters (2)
urlstring
featureTypeint
Returns (1)
void

History 3

ScreenGuiEnabled

TypeDefault
bool

History 2

SendNotification

Parameters (5)
titlestring
textstring
imagestring
durationint
callbackFunction
Returns (1)
void

History 2

SetErrorMessage

Parameters (1)
errorMessagestring
Returns (1)
void
This function is deprecated. It exists only for backward compatibility, and should not be used for new work.

History 5

Tags: [Deprecated]

SetGlobalSizeOffsetPixel

Parameters (2)
xint
yint
Returns (1)
void

History 4

ShowAppShellTabBar

Parameters (1)
valuebool
Returns (1)
void

History 2

ShowLegacyPlayerList

TypeDefault
bool

History 2

TopbarInsetChanged

Parameters (1)
topbarInsetDictionary

History 2

UseLuaChat

TypeDefault
bool
This property is read-only. Its value can be read, but it cannot be modified.

History 2

Tags: [ReadOnly]

Version

TypeDefault
double
This property is read-only. Its value can be read, but it cannot be modified.

History 2

Tags: [ReadOnly]

Settings