Roblox API Reference

GuiService On DevHub

Summary

This class is not creatable. An object of this class cannot be created with Instance.new.
This class is a service. It is a singleton that may be acquired with GetService.
This item is not replicated. Its interface does not cross the network boundary.

Tags: [NotCreatable, Service, NotReplicated]

Inherits (1)

Member index (75)

Type Member History
bool AutoSelectGuiEnabled 201
Folder CoreEffectFolder 265 264 265 329
Folder CoreGuiFolder 265 264 265 329
bool CoreGuiNavigationEnabled 234
bool GuiNavigationEnabled 201
bool IsModalDialog 213
bool IsWindows 67 66 67 213
bool MenuIsOpen 213
GuiObject SelectedCoreObject 196 329 469 469
GuiObject SelectedObject 193 197 197 329
bool TouchControlsEnabled 493
void AddCenterDialog (Instance dialog, CenterDialogType centerDialogType, Function showFunction, Function hideFunction)
void AddKey (string key)
void AddSelectionParent (string selectionName, Instance selectionParent) 193
void AddSelectionTuple (string selectionName, Tuple selections) 193
void AddSpecialKey (SpecialKey key)
void BroadcastNotification (string data, int notificationType) 303
void ClearError () 356
void CloseInspectMenu () 384
bool CloseStatsBasedOnInputString (string input) 297
void ForceTenFootInterface (bool isForced) 416
int GetBrickCount () 157
Instance GetClosestDialogToPosition (Vector3 position) 206
bool GetEmotesMenuOpen () 381
ConnectionError GetErrorCode () 347
string GetErrorMessage () 157 182
ConnectionError GetErrorType () 347
bool GetGameplayPausedNotificationEnabled () 398
Tuple GetGuiInset () 267
bool GetInspectMenuEnabled () 384
Dictionary GetNotificationTypeList () 303
int GetResolutionScale () 290 383
Dictionary GetSafeZoneOffsets () 339
Vector2 GetScreenResolution () 131
string GetUiMessage () 182
void InspectPlayerFromHumanoidDescription (Instance humanoidDescription, string name) 384
void InspectPlayerFromUserId (int64 userId) 384
void InspectPlayerFromUserIdWithCtx (int64 userId, string ctx) 394
bool IsMemoryTrackerEnabled () 298
bool IsTenFootInterface () 232 252
void OpenBrowserWindow (string url) 83 371
void OpenNativeOverlay (string title, string url) 298 371
void RemoveCenterDialog (Instance dialog)
void RemoveKey (string key) 125
void RemoveSelectionGroup (string selectionName) 193
void RemoveSpecialKey (SpecialKey key) 171
void Select (Instance selectionParent) 519 523
void SetEmotesMenuOpen (bool isOpen) 381
void SetGameplayPausedNotificationEnabled (bool enabled) 398
void SetGlobalGuiInset (int x1, int y1, int x2, int y2) 91 90 91
void SetInspectMenuEnabled (bool enabled) 384
void SetMenuIsOpen (bool open, string menuName = default) 213 378
void SetSafeZoneOffsets (float top, float bottom, float left, float right) 339
void SetUiMessage (UiMessageType msgType, string uiMessage = errorCode) 182 347
bool ShowStatsBasedOnInputString (string input) 219
void ToggleFullscreen () 201
BrowserWindowClosed () 124 371
CloseInspectMenuRequest () 384
CoreGuiRenderOverflowed () 488 488 489
EmotesMenuOpenChanged (bool isOpen) 381
ErrorMessageChanged (string newErrorMessage) 157 182
InspectMenuEnabledChangedSignal (bool enabled) 384
InspectPlayerFromHumanoidDescriptionRequest (Instance humanoidDescription, string name) 384
InspectPlayerFromUserIdWithCtxRequest (int64 userId, string ctx) 394
KeyPressed (string key, string modifiers)
MenuClosed () 213
MenuOpened () 213
NativeClose () 435
NetworkPausedEnabledChanged (bool enabled) 398
Open9SliceEditor (Instance selectedImageObject) 487
SafeZoneOffsetsChanged () 339
ShowLeaveConfirmation () 162
SpecialKeyPressed (SpecialKey key, string modifiers)
UiMessageChanged (UiMessageType msgType, string newUiMessage) 182
void SendCoreUiNotification (string title, string text) 211
51 members inherited from Instance

Removed member index (17)

Type Member History
bool GamepadNavigationEnabled 196 201
bool RenderHumanoidBillboards 447 448
bool ScreenGuiEnabled 244 304
bool ShowLegacyPlayerList 213
bool UseLuaChat 67 66 67 213
double Version 213
int GetConnectorCount () 157 213
int GetInstanceCount () 157 213
Dictionary GetNativeViewFeatureList () 301 303
float GetVoxelCount () 157 168 213
void RequestNativeView (string url, int featureType) 298 301 303
void SendNotification (string title, string text, string image, int duration, Function callback) 190
void SetErrorMessage (string errorMessage) 157 182 273 272 273
void SetGlobalSizeOffsetPixel (int x, int y) 91 90 91
void ShowAppShellTabBar (bool value) 300 303
EscapeKeyPressed () 304
InspectPlayerFromUserIdRequest (int64 userId) 384 420

History

Members

AddCenterDialog On DevHub

Name Type Default
dialog Instance none
centerDialogType CenterDialogType none
showFunction Function none
hideFunction Function none

AddKey On DevHub

Name Type Default
key string none

AddSelectionParent On DevHub

Name Type Default
selectionName string none
selectionParent Instance none

History

AddSelectionTuple On DevHub

Name Type Default
selectionName string none
selections Tuple none

History

AddSpecialKey On DevHub

Name Type Default
key SpecialKey none

AutoSelectGuiEnabled On DevHub

History

BroadcastNotification On DevHub

Name Type Default
data string none
notificationType int none

History

BrowserWindowClosed On DevHub

This item is deprecated. It exists for backwards-compatibility only, and should not be used for new work.
Name Type Default
No parameters.

History

Tags: [Deprecated]

ClearError On DevHub

Name Type Default
No parameters.

History

CloseInspectMenu On DevHub

Name Type Default
No parameters.

History

CloseInspectMenuRequest On DevHub

Name Type Default
No parameters.

History

CloseStatsBasedOnInputString On DevHub

Name Type Default
input string none

History

CoreEffectFolder On DevHub

This member is hidden. It is not meant to be used, and may have unresolved issues.
This item is not replicated. Its interface does not cross the network boundary.

History

Tags: [Hidden, NotReplicated]

CoreGuiFolder On DevHub

This member is hidden. It is not meant to be used, and may have unresolved issues.
This item is not replicated. Its interface does not cross the network boundary.

History

Tags: [Hidden, NotReplicated]

CoreGuiNavigationEnabled On DevHub

History

CoreGuiRenderOverflowed On DevHub

Name Type Default
No parameters.

History

EmotesMenuOpenChanged On DevHub

Name Type Default
isOpen bool none

History

ErrorMessageChanged On DevHub

This item is deprecated. It exists for backwards-compatibility only, and should not be used for new work.
Name Type Default
newErrorMessage string none

History

Tags: [Deprecated]

ForceTenFootInterface On DevHub

Name Type Default
isForced bool none

History

GetBrickCount On DevHub

Name Type Default
No parameters.

History

GetClosestDialogToPosition On DevHub

Name Type Default
position Vector3 none

History

GetEmotesMenuOpen On DevHub

Name Type Default
No parameters.

History

GetErrorCode On DevHub

Name Type Default
No parameters.

History

GetErrorMessage On DevHub

This item is deprecated. It exists for backwards-compatibility only, and should not be used for new work.
Name Type Default
No parameters.

History

Tags: [Deprecated]

GetErrorType On DevHub

Name Type Default
No parameters.

History

GetGameplayPausedNotificationEnabled On DevHub

Name Type Default
No parameters.

History

GetGuiInset On DevHub

Name Type Default
No parameters.

History

GetInspectMenuEnabled On DevHub

Name Type Default
No parameters.

History

GetNotificationTypeList On DevHub

Name Type Default
No parameters.

History

GetResolutionScale On DevHub

Name Type Default
No parameters.

History

GetSafeZoneOffsets On DevHub

Name Type Default
No parameters.

History

GetScreenResolution On DevHub

This function yields. It will block the calling thread until completion.
Name Type Default
No parameters.

History

Tags: [Yields]

GetUiMessage On DevHub

Name Type Default
No parameters.

History

GuiNavigationEnabled On DevHub

History

InspectMenuEnabledChangedSignal On DevHub

Name Type Default
enabled bool none

History

InspectPlayerFromHumanoidDescription On DevHub

Name Type Default
humanoidDescription Instance none
name string none

History

InspectPlayerFromHumanoidDescriptionRequest On DevHub

Name Type Default
humanoidDescription Instance none
name string none

History

InspectPlayerFromUserId On DevHub

Name Type Default
userId int64 none

History

InspectPlayerFromUserIdWithCtx On DevHub

Name Type Default
userId int64 none
ctx string none

History

InspectPlayerFromUserIdWithCtxRequest On DevHub

Name Type Default
userId int64 none
ctx string none

History

IsMemoryTrackerEnabled On DevHub

Name Type Default
No parameters.

History

IsModalDialog On DevHub

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

History

Tags: [ReadOnly, NotReplicated, Deprecated]

IsTenFootInterface On DevHub

Name Type Default
No parameters.

History

IsWindows On DevHub

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

History

Tags: [ReadOnly, NotReplicated, Deprecated]

KeyPressed On DevHub

Name Type Default
key string none
modifiers string none

MenuClosed On DevHub

Name Type Default
No parameters.

History

MenuIsOpen On DevHub

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

History

Tags: [ReadOnly, NotReplicated]

MenuOpened On DevHub

Name Type Default
No parameters.

History

NativeClose On DevHub

Name Type Default
No parameters.

History

NetworkPausedEnabledChanged On DevHub

Name Type Default
enabled bool none

History

Open9SliceEditor On DevHub

Name Type Default
selectedImageObject Instance none

History

OpenBrowserWindow On DevHub

This item is deprecated. It exists for backwards-compatibility only, and should not be used for new work.
Name Type Default
url string none

History

Tags: [Deprecated]

OpenNativeOverlay On DevHub

This item is deprecated. It exists for backwards-compatibility only, and should not be used for new work.
Name Type Default
title string none
url string none

History

Tags: [Deprecated]

RemoveCenterDialog On DevHub

Name Type Default
dialog Instance none

RemoveKey On DevHub

Name Type Default
key string none

History

RemoveSelectionGroup On DevHub

Name Type Default
selectionName string none

History

RemoveSpecialKey On DevHub

Name Type Default
key SpecialKey none

History

SafeZoneOffsetsChanged On DevHub

Name Type Default
No parameters.

History

Select On DevHub

Name Type Default
selectionParent Instance none

History

SelectedCoreObject On DevHub

This member is hidden. It is not meant to be used, and may have unresolved issues.
This item is not replicated. Its interface does not cross the network boundary.

History

Tags: [Hidden, NotReplicated]

SelectedObject On DevHub

History

SendCoreUiNotification On DevHub

Name Type Default
title string none
text string none

History

SetEmotesMenuOpen On DevHub

Name Type Default
isOpen bool none

History

SetGameplayPausedNotificationEnabled On DevHub

Name Type Default
enabled bool none

History

SetGlobalGuiInset On DevHub

Name Type Default
x1 int none
y1 int none
x2 int none
y2 int none

History

SetInspectMenuEnabled On DevHub

Name Type Default
enabled bool none

History

SetMenuIsOpen On DevHub

Name Type Default
open bool none
menuName string default

History

SetSafeZoneOffsets On DevHub

Name Type Default
top float none
bottom float none
left float none
right float none

History

SetUiMessage On DevHub

Name Type Default
msgType UiMessageType none
uiMessage string errorCode

History

ShowLeaveConfirmation On DevHub

Name Type Default
No parameters.

History

ShowStatsBasedOnInputString On DevHub

Name Type Default
input string none

History

SpecialKeyPressed On DevHub

Name Type Default
key SpecialKey none
modifiers string none

ToggleFullscreen On DevHub

Name Type Default
No parameters.

History

TouchControlsEnabled On DevHub

History

UiMessageChanged On DevHub

Name Type Default
msgType UiMessageType none
newUiMessage string none

History

Removed members

EscapeKeyPressed

Name Type Default
No parameters.

History

GamepadNavigationEnabled

History

GetConnectorCount

Name Type Default
No parameters.

History

GetInstanceCount

Name Type Default
No parameters.

History

GetNativeViewFeatureList

Name Type Default
No parameters.

History

GetVoxelCount

Name Type Default
No parameters.

History

InspectPlayerFromUserIdRequest

Name Type Default
userId int64 none

History

RenderHumanoidBillboards

This member is hidden. It is not meant to be used, and may have unresolved issues.
This item is not replicated. Its interface does not cross the network boundary.

History

Tags: [Hidden, NotReplicated]

RequestNativeView

Name Type Default
url string none
featureType int none

History

ScreenGuiEnabled

History

SendNotification

Name Type Default
title string none
text string none
image string none
duration int none
callback Function none

History

SetErrorMessage

This item is deprecated. It exists for backwards-compatibility only, and should not be used for new work.
Name Type Default
errorMessage string none

History

Tags: [Deprecated]

SetGlobalSizeOffsetPixel

Name Type Default
x int none
y int none

History

ShowAppShellTabBar

Name Type Default
value bool none

History

ShowLegacyPlayerList

History

UseLuaChat

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

History

Tags: [ReadOnly]

Version

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

History

Tags: [ReadOnly]

Relevant classes (3)

Relevant enums (4)