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.

Memory Category	Instances

Tags: [NotCreatable, Service, NotReplicated]

Inherits (1)

Instance

Member index (88)

Type	Member	History
bool	AutoSelectGuiEnabled	201
Folder	CoreEffectFolder	265 264 265 329
Folder	CoreGuiFolder	265 264 265 329
bool	CoreGuiNavigationEnabled	234 536 536 536
bool	GuiNavigationEnabled	201
bool	IsModalDialog	213
bool	IsWindows	67 66 67 213
bool	MenuIsOpen	213
float	PreferredTransparency	583
bool	ReducedMotionEnabled	583
GuiObject	SelectedCoreObject	196 329 469 469
GuiObject	SelectedObject	193 197 197 329
Rect	TopbarInset	591 599
bool	TouchControlsEnabled	493
null	AddCenterDialog (Instance dialog, CenterDialogType centerDialogType, Function showFunction, Function hideFunction)	573
null	AddKey (string key)	573
null	AddSelectionParent (string selectionName, Instance selectionParent)	193 573
null	AddSelectionTuple (string selectionName, Tuple selections)	193 573
null	AddSpecialKey (SpecialKey key)	573
null	BroadcastNotification (string data, int notificationType)	303 573
null	ClearError ()	356 573
null	CloseInspectMenu ()	384 573
bool	CloseStatsBasedOnInputString (string input)	297
null	ForceTenFootInterface (bool isForced)	416 573
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	GetGuiIsVisible (GuiType guiType)	538
Vector2	GetHardwareSafeViewport ()	592
bool	GetInspectMenuEnabled ()	384
Dictionary	GetNotificationTypeList ()	303
int	GetResolutionScale ()	290 383
Dictionary	GetSafeZoneOffsets ()	339
Vector2	GetScreenResolution ()	131
string	GetUiMessage ()	182
null	InspectPlayerFromHumanoidDescription (Instance humanoidDescription, string name)	384 573
null	InspectPlayerFromUserId (int64 userId)	384 573
null	InspectPlayerFromUserIdWithCtx (int64 userId, string ctx)	394 573
bool	IsMemoryTrackerEnabled ()	298
bool	IsTenFootInterface ()	232 252
null	OpenBrowserWindow (string url)	83 371 573
null	OpenNativeOverlay (string title, string url)	298 371 573
null	RemoveCenterDialog (Instance dialog)	573
null	RemoveKey (string key)	125 573
null	RemoveSelectionGroup (string selectionName)	193 573
null	RemoveSpecialKey (SpecialKey key)	171 573
null	Select (Instance selectionParent)	519 523 573
null	SendUIOcclusionMetricsForQueryRegion (UDim2 position, UDim2 size, string regionName)	598
null	SetEmotesMenuOpen (bool isOpen)	381 573
null	SetGameplayPausedNotificationEnabled (bool enabled)	398 573
null	SetGlobalGuiInset (int x1, int y1, int x2, int y2)	91 90 91 573
null	SetHardwareSafeAreaInsets (float left, float top, float right, float bottom)	546 573
null	SetInspectMenuEnabled (bool enabled)	384 573
null	SetMenuIsOpen (bool open, string menuName = default)	213 378 573
null	SetPurchasePromptIsShown (bool isShown)	561 573
null	SetSafeZoneOffsets (float top, float bottom, float left, float right)	339 573
null	SetTopbarInset (Rect topbarInset)	590 591
null	SetUiMessage (UiMessageType msgType, string uiMessage = errorCode)	182 347 573
bool	ShowStatsBasedOnInputString (string input)	219
null	ToggleFullscreen ()	201 573
null	ToggleGuiIsVisibleForCaptures (GuiType guiType)	587
null	ToggleGuiIsVisibleIfAllowed (GuiType guiType)	538 573
	BrowserWindowClosed ()	124 371
	CloseInspectMenuRequest ()	384
	CoreGuiRenderOverflowed ()	488 488 489
	EmotesMenuOpenChanged (bool isOpen)	381
	ErrorMessageChanged (string newErrorMessage)	157 182
	GuiVisibilityChangedSignal (GuiType guiType, bool visible)	538
	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
	PurchasePromptShown ()	561
	SafeZoneOffsetsChanged ()	339
	ShowLeaveConfirmation ()	162
	SpecialKeyPressed (SpecialKey key, string modifiers)
	UiMessageChanged (UiMessageType msgType, string newUiMessage)	182
null	SendCoreUiNotification (string title, string text)	211 573
57 members inherited from Instance

Removed member index (18)

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
	TopbarInsetChanged (Dictionary topbarInset)	590 591

599 Change Tags of GuiService.TopbarInset from [Hidden, ReadOnly, NotReplicated] to [ReadOnly, NotReplicated]
598 Add GuiService.SendUIOcclusionMetricsForQueryRegion
592 Add GuiService.GetHardwareSafeViewport
591 Add GuiService.TopbarInset
591 Change Parameters of GuiService.SetTopbarInset from (Dictionary topbarInset) to (Rect topbarInset)
591 Remove GuiService.TopbarInsetChanged
590 Add GuiService.SetTopbarInset
590 Add GuiService.TopbarInsetChanged
587 Add GuiService.ToggleGuiIsVisibleForCaptures
583 Add GuiService.PreferredTransparency
583 Add GuiService.ReducedMotionEnabled
573 Change ReturnType of GuiService.AddCenterDialog from void to null
573 Change ReturnType of GuiService.AddKey from void to null
573 Change ReturnType of GuiService.AddSelectionParent from void to null
573 Change ReturnType of GuiService.AddSelectionTuple from void to null
573 Change ReturnType of GuiService.AddSpecialKey from void to null
573 Change ReturnType of GuiService.BroadcastNotification from void to null
573 Change ReturnType of GuiService.ClearError from void to null
573 Change ReturnType of GuiService.CloseInspectMenu from void to null
573 Change ReturnType of GuiService.ForceTenFootInterface from void to null
573 Change ReturnType of GuiService.InspectPlayerFromHumanoidDescription from void to null
573 Change ReturnType of GuiService.InspectPlayerFromUserId from void to null
573 Change ReturnType of GuiService.InspectPlayerFromUserIdWithCtx from void to null
573 Change ReturnType of GuiService.OpenBrowserWindow from void to null
573 Change ReturnType of GuiService.OpenNativeOverlay from void to null
573 Change ReturnType of GuiService.RemoveCenterDialog from void to null
573 Change ReturnType of GuiService.RemoveKey from void to null
573 Change ReturnType of GuiService.RemoveSelectionGroup from void to null
573 Change ReturnType of GuiService.RemoveSpecialKey from void to null
573 Change ReturnType of GuiService.Select from void to null
573 Change ReturnType of GuiService.SetEmotesMenuOpen from void to null
573 Change ReturnType of GuiService.SetGameplayPausedNotificationEnabled from void to null
573 Change ReturnType of GuiService.SetGlobalGuiInset from void to null
573 Change ReturnType of GuiService.SetHardwareSafeAreaInsets from void to null
573 Change ReturnType of GuiService.SetInspectMenuEnabled from void to null
573 Change ReturnType of GuiService.SetMenuIsOpen from void to null
573 Change ReturnType of GuiService.SetPurchasePromptIsShown from void to null
573 Change ReturnType of GuiService.SetSafeZoneOffsets from void to null
573 Change ReturnType of GuiService.SetUiMessage from void to null
573 Change ReturnType of GuiService.ToggleFullscreen from void to null
573 Change ReturnType of GuiService.ToggleGuiIsVisibleIfAllowed from void to null
573 Change ReturnType of GuiService.SendCoreUiNotification from void to null
561 Add GuiService.SetPurchasePromptIsShown
561 Add GuiService.PurchasePromptShown
546 Add GuiService.SetHardwareSafeAreaInsets
538 Add GuiService.GetGuiIsVisible
538 Add GuiService.ToggleGuiIsVisibleIfAllowed
538 Add GuiService.GuiVisibilityChangedSignal
536 Change CanLoad of GuiService.CoreGuiNavigationEnabled from true to false
536 Change CanSave of GuiService.CoreGuiNavigationEnabled from true to false
536 Change Tags of GuiService.CoreGuiNavigationEnabled from [] to [Hidden, NotReplicated]
523 Change Security of GuiService.Select from RobloxScriptSecurity to None
519 Add GuiService.Select
493 Add GuiService.TouchControlsEnabled
489 Add GuiService.CoreGuiRenderOverflowed
488 Remove GuiService.CoreGuiRenderOverflowed
488 Add GuiService.CoreGuiRenderOverflowed
487 Add GuiService.Open9SliceEditor
469 Change CanLoad of GuiService.SelectedCoreObject from true to false
469 Change Tags of GuiService.SelectedCoreObject from [NotReplicated] to [Hidden, NotReplicated]
448 Remove GuiService.RenderHumanoidBillboards
447 Add GuiService.RenderHumanoidBillboards
435 Add GuiService.NativeClose
420 Remove GuiService.InspectPlayerFromUserIdRequest
416 Add GuiService.ForceTenFootInterface
398 Add GuiService.GetGameplayPausedNotificationEnabled
398 Add GuiService.SetGameplayPausedNotificationEnabled
398 Add GuiService.NetworkPausedEnabledChanged
394 Add GuiService.InspectPlayerFromUserIdWithCtx
394 Add GuiService.InspectPlayerFromUserIdWithCtxRequest
384 Add GuiService.CloseInspectMenu
384 Add GuiService.GetInspectMenuEnabled
384 Add GuiService.InspectPlayerFromHumanoidDescription
384 Add GuiService.InspectPlayerFromUserId
384 Add GuiService.SetInspectMenuEnabled
384 Add GuiService.CloseInspectMenuRequest
384 Add GuiService.InspectMenuEnabledChangedSignal
384 Add GuiService.InspectPlayerFromHumanoidDescriptionRequest
384 Add GuiService.InspectPlayerFromUserIdRequest
383 Change Security of GuiService.GetResolutionScale from LocalUserSecurity to RobloxScriptSecurity
381 Add GuiService.GetEmotesMenuOpen
381 Add GuiService.SetEmotesMenuOpen
381 Add GuiService.EmotesMenuOpenChanged
378 Change Parameters of GuiService.SetMenuIsOpen from (bool open) to (bool open, string menuName = default)
371 Change Tags of GuiService.OpenBrowserWindow from [] to [Deprecated]
371 Change Tags of GuiService.OpenNativeOverlay from [] to [Deprecated]
371 Change Tags of GuiService.BrowserWindowClosed from [] to [Deprecated]
356 Add GuiService.ClearError
347 Add GuiService.GetErrorCode
347 Add GuiService.GetErrorType
347 Change Parameters of GuiService.SetUiMessage from (UiMessageType msgType, string uiMessage) to (UiMessageType msgType, string uiMessage = errorCode)
339 Add GuiService.GetSafeZoneOffsets
339 Add GuiService.SetSafeZoneOffsets
339 Add GuiService.SafeZoneOffsetsChanged
329 Change ValueType of GuiService.CoreEffectFolder from Object to Folder
329 Change ValueType of GuiService.CoreGuiFolder from Object to Folder
329 Change ValueType of GuiService.SelectedCoreObject from Object to GuiObject
329 Change ValueType of GuiService.SelectedObject from Object to GuiObject
304 Remove GuiService.ScreenGuiEnabled
304 Remove GuiService.EscapeKeyPressed
303 Add GuiService.BroadcastNotification
303 Remove GuiService.GetNativeViewFeatureList
303 Add GuiService.GetNotificationTypeList
303 Remove GuiService.RequestNativeView
303 Remove GuiService.ShowAppShellTabBar
301 Add GuiService.GetNativeViewFeatureList
301 Change Parameters of GuiService.RequestNativeView from (string url) to (string url, int featureType)
300 Add GuiService.ShowAppShellTabBar
298 Add GuiService.IsMemoryTrackerEnabled
298 Add GuiService.OpenNativeOverlay
298 Add GuiService.RequestNativeView
297 Add GuiService.CloseStatsBasedOnInputString
290 Add GuiService.GetResolutionScale
273 Remove GuiService.SetErrorMessage
272 Add GuiService.SetErrorMessage
273 Remove GuiService.SetErrorMessage
267 Add GuiService.GetGuiInset
265 Add GuiService.CoreEffectFolder
265 Add GuiService.CoreGuiFolder
264 Remove GuiService.CoreEffectFolder
264 Remove GuiService.CoreGuiFolder
265 Add GuiService.CoreEffectFolder
265 Add GuiService.CoreGuiFolder
252 Change Security of GuiService.IsTenFootInterface from RobloxScriptSecurity to None
244 Add GuiService.ScreenGuiEnabled
234 Add GuiService.CoreGuiNavigationEnabled
232 Add GuiService.IsTenFootInterface
219 Add GuiService.ShowStatsBasedOnInputString
213 Change Tags of GuiService.IsModalDialog from [ReadOnly, NotReplicated] to [ReadOnly, NotReplicated, Deprecated]
213 Change Tags of GuiService.IsWindows from [ReadOnly, NotReplicated] to [ReadOnly, NotReplicated, Deprecated]
213 Add GuiService.MenuIsOpen
213 Remove GuiService.ShowLegacyPlayerList
213 Remove GuiService.UseLuaChat
213 Remove GuiService.Version
213 Remove GuiService.GetConnectorCount
213 Remove GuiService.GetInstanceCount
213 Remove GuiService.GetVoxelCount
213 Add GuiService.SetMenuIsOpen
213 Add GuiService.MenuClosed
213 Add GuiService.MenuOpened
211 Add GuiService.SendCoreUiNotification
206 Add GuiService.GetClosestDialogToPosition
201 Add GuiService.AutoSelectGuiEnabled
201 Remove GuiService.GamepadNavigationEnabled
201 Add GuiService.GuiNavigationEnabled
201 Add GuiService.ToggleFullscreen
197 Change ReadSecurity of GuiService.SelectedObject from RobloxScriptSecurity to None
197 Change WriteSecurity of GuiService.SelectedObject from RobloxScriptSecurity to None
196 Add GuiService.GamepadNavigationEnabled
196 Add GuiService.SelectedCoreObject
193 Add GuiService.SelectedObject
193 Add GuiService.AddSelectionParent
193 Add GuiService.AddSelectionTuple
193 Add GuiService.RemoveSelectionGroup
190 Remove GuiService.SendNotification
182 Change Tags of GuiService.GetErrorMessage from [] to [Deprecated]
182 Add GuiService.GetUiMessage
182 Change Tags of GuiService.SetErrorMessage from [] to [Deprecated]
182 Add GuiService.SetUiMessage
182 Change Tags of GuiService.ErrorMessageChanged from [] to [Deprecated]
182 Add GuiService.UiMessageChanged
171 Add GuiService.RemoveSpecialKey
168 Change ReturnType of GuiService.GetVoxelCount from int to float
162 Add GuiService.ShowLeaveConfirmation
157 Add GuiService.GetBrickCount
157 Add GuiService.GetConnectorCount
157 Add GuiService.GetErrorMessage
157 Add GuiService.GetInstanceCount
157 Add GuiService.GetVoxelCount
157 Add GuiService.SetErrorMessage
157 Add GuiService.ErrorMessageChanged
131 Add GuiService.GetScreenResolution
125 Add GuiService.RemoveKey
124 Add GuiService.BrowserWindowClosed
91 Add GuiService.SetGlobalGuiInset
91 Remove GuiService.SetGlobalSizeOffsetPixel
90 Remove GuiService.SetGlobalGuiInset
90 Add GuiService.SetGlobalSizeOffsetPixel
91 Add GuiService.SetGlobalGuiInset
91 Remove GuiService.SetGlobalSizeOffsetPixel
83 Add GuiService.OpenBrowserWindow
67 Add GuiService.IsWindows
67 Add GuiService.UseLuaChat
66 Remove GuiService.IsWindows
66 Remove GuiService.UseLuaChat
67 Add GuiService.IsWindows
67 Add GuiService.UseLuaChat

Members

AddCenterDialog On DevHub

Parameters	4

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

Return Type	null
Security	RobloxScriptSecurity

History

573 Change ReturnType of GuiService.AddCenterDialog from void to null

AddKey On DevHub

Parameters	1

Name	Type	Default
key	string	none

Return Type	null
Security	RobloxScriptSecurity

History

573 Change ReturnType of GuiService.AddKey from void to null

AddSelectionParent On DevHub

Parameters	2

Name	Type	Default
selectionName	string	none
selectionParent	Instance	none

Return Type	null

History

573 Change ReturnType of GuiService.AddSelectionParent from void to null
193 Add GuiService.AddSelectionParent

AddSelectionTuple On DevHub

Parameters	2

Name	Type	Default
selectionName	string	none
selections	Tuple	none

Return Type	null

History

573 Change ReturnType of GuiService.AddSelectionTuple from void to null
193 Add GuiService.AddSelectionTuple

AddSpecialKey On DevHub

Parameters	1

Name	Type	Default
key	SpecialKey	none

Return Type	null
Security	RobloxScriptSecurity

History

573 Change ReturnType of GuiService.AddSpecialKey from void to null

AutoSelectGuiEnabled On DevHub

Value Type	bool
Category	Data
Can Load	true
Can Save	true

History

201 Add GuiService.AutoSelectGuiEnabled

BroadcastNotification On DevHub

Parameters	2

Name	Type	Default
data	string	none
notificationType	int	none

Return Type	null
Security	RobloxScriptSecurity

History

573 Change ReturnType of GuiService.BroadcastNotification from void to null
303 Add GuiService.BroadcastNotification

BrowserWindowClosed On DevHub

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

Parameters	0

Name	Type	Default
No parameters.

Security	RobloxScriptSecurity

History

371 Change Tags of GuiService.BrowserWindowClosed from [] to [Deprecated]
124 Add GuiService.BrowserWindowClosed

Tags: [Deprecated]

ClearError On DevHub

Parameters	0

Name	Type	Default
No parameters.

Return Type	null
Security	RobloxScriptSecurity

History

573 Change ReturnType of GuiService.ClearError from void to null
356 Add GuiService.ClearError

CloseInspectMenu On DevHub

Parameters	0

Name	Type	Default
No parameters.

Return Type	null

History

573 Change ReturnType of GuiService.CloseInspectMenu from void to null
384 Add GuiService.CloseInspectMenu

CloseInspectMenuRequest On DevHub

Parameters	0

Name	Type	Default
No parameters.

Security	RobloxScriptSecurity

History

384 Add GuiService.CloseInspectMenuRequest

CloseStatsBasedOnInputString On DevHub

Parameters	1

Name	Type	Default
input	string	none

Return Type	bool
Security	RobloxScriptSecurity

History

297 Add GuiService.CloseStatsBasedOnInputString

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.

Value Type	Folder
Security	RobloxScriptSecurity
Category	Data
Can Load	false
Can Save	false

History

329 Change ValueType of GuiService.CoreEffectFolder from Object to Folder
265 Add GuiService.CoreEffectFolder
264 Remove GuiService.CoreEffectFolder
265 Add GuiService.CoreEffectFolder

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.

Value Type	Folder
Security	RobloxScriptSecurity
Category	Data
Can Load	false
Can Save	false

History

329 Change ValueType of GuiService.CoreGuiFolder from Object to Folder
265 Add GuiService.CoreGuiFolder
264 Remove GuiService.CoreGuiFolder
265 Add GuiService.CoreGuiFolder

Tags: [Hidden, NotReplicated]

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

Value Type	bool
Category	Data
Can Load	false
Can Save	false

History

536 Change CanLoad of GuiService.CoreGuiNavigationEnabled from true to false
536 Change CanSave of GuiService.CoreGuiNavigationEnabled from true to false
536 Change Tags of GuiService.CoreGuiNavigationEnabled from [] to [Hidden, NotReplicated]
234 Add GuiService.CoreGuiNavigationEnabled

Tags: [Hidden, NotReplicated]

CoreGuiRenderOverflowed On DevHub

Parameters	0

Name	Type	Default
No parameters.

Security	RobloxScriptSecurity

History

489 Add GuiService.CoreGuiRenderOverflowed
488 Remove GuiService.CoreGuiRenderOverflowed
488 Add GuiService.CoreGuiRenderOverflowed

EmotesMenuOpenChanged On DevHub

Parameters	1

Name	Type	Default
isOpen	bool	none

Security	RobloxScriptSecurity

History

381 Add GuiService.EmotesMenuOpenChanged

ErrorMessageChanged On DevHub

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

Parameters	1

Name	Type	Default
newErrorMessage	string	none

Security	RobloxScriptSecurity

History

182 Change Tags of GuiService.ErrorMessageChanged from [] to [Deprecated]
157 Add GuiService.ErrorMessageChanged

Tags: [Deprecated]

ForceTenFootInterface On DevHub

Parameters	1

Name	Type	Default
isForced	bool	none

Return Type	null
Security	RobloxScriptSecurity

History

573 Change ReturnType of GuiService.ForceTenFootInterface from void to null
416 Add GuiService.ForceTenFootInterface

GetBrickCount On DevHub

Parameters	0

Name	Type	Default
No parameters.

Return Type	int
Security	RobloxScriptSecurity

History

157 Add GuiService.GetBrickCount

GetClosestDialogToPosition On DevHub

Parameters	1

Name	Type	Default
position	Vector3	none

Return Type	Instance
Security	RobloxScriptSecurity

History

206 Add GuiService.GetClosestDialogToPosition

GetEmotesMenuOpen On DevHub

Parameters	0

Name	Type	Default
No parameters.

Return Type	bool

History

381 Add GuiService.GetEmotesMenuOpen

GetErrorCode On DevHub

Parameters	0

Name	Type	Default
No parameters.

Return Type	ConnectionError
Security	RobloxScriptSecurity

History

347 Add GuiService.GetErrorCode

GetErrorMessage On DevHub

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

Parameters	0

Name	Type	Default
No parameters.

Return Type	string
Security	RobloxScriptSecurity

History

182 Change Tags of GuiService.GetErrorMessage from [] to [Deprecated]
157 Add GuiService.GetErrorMessage

Tags: [Deprecated]

GetErrorType On DevHub

Parameters	0

Name	Type	Default
No parameters.

Return Type	ConnectionError
Security	RobloxScriptSecurity

History

347 Add GuiService.GetErrorType

GetGameplayPausedNotificationEnabled On DevHub

Parameters	0

Name	Type	Default
No parameters.

Return Type	bool

History

398 Add GuiService.GetGameplayPausedNotificationEnabled

GetGuiInset On DevHub

Parameters	0

Name	Type	Default
No parameters.

Return Type	Tuple

History

267 Add GuiService.GetGuiInset

GetGuiIsVisible On DevHub

Parameters	1

Name	Type	Default
guiType	GuiType	none

Return Type	bool
Security	RobloxScriptSecurity

History

538 Add GuiService.GetGuiIsVisible

GetHardwareSafeViewport On DevHub

Parameters	0

Name	Type	Default
No parameters.

Return Type	Vector2
Security	RobloxScriptSecurity

History

592 Add GuiService.GetHardwareSafeViewport

GetInspectMenuEnabled On DevHub

Parameters	0

Name	Type	Default
No parameters.

Return Type	bool

History

384 Add GuiService.GetInspectMenuEnabled

GetNotificationTypeList On DevHub

Parameters	0

Name	Type	Default
No parameters.

Return Type	Dictionary
Security	RobloxScriptSecurity

History

303 Add GuiService.GetNotificationTypeList

GetResolutionScale On DevHub

Parameters	0

Name	Type	Default
No parameters.

Return Type	int
Security	RobloxScriptSecurity

History

383 Change Security of GuiService.GetResolutionScale from LocalUserSecurity to RobloxScriptSecurity
290 Add GuiService.GetResolutionScale

GetSafeZoneOffsets On DevHub

Parameters	0

Name	Type	Default
No parameters.

Return Type	Dictionary
Security	RobloxScriptSecurity

History

339 Add GuiService.GetSafeZoneOffsets

GetScreenResolution On DevHub

This function yields. It will block the calling thread until completion.

Parameters	0

Name	Type	Default
No parameters.

Return Type	Vector2
Security	RobloxScriptSecurity

History

131 Add GuiService.GetScreenResolution

Tags: [Yields]

GetUiMessage On DevHub

Parameters	0

Name	Type	Default
No parameters.

Return Type	string
Security	RobloxScriptSecurity

History

182 Add GuiService.GetUiMessage

GuiNavigationEnabled On DevHub

Value Type	bool
Category	Data
Can Load	true
Can Save	true

History

201 Add GuiService.GuiNavigationEnabled

GuiVisibilityChangedSignal On DevHub

Parameters	2

Name	Type	Default
guiType	GuiType	none
visible	bool	none

Security	RobloxScriptSecurity

History

538 Add GuiService.GuiVisibilityChangedSignal

InspectMenuEnabledChangedSignal On DevHub

Parameters	1

Name	Type	Default
enabled	bool	none

Security	RobloxScriptSecurity

History

384 Add GuiService.InspectMenuEnabledChangedSignal

InspectPlayerFromHumanoidDescription On DevHub

Parameters	2

Name	Type	Default
humanoidDescription	Instance	none
name	string	none

Return Type	null

History

573 Change ReturnType of GuiService.InspectPlayerFromHumanoidDescription from void to null
384 Add GuiService.InspectPlayerFromHumanoidDescription

InspectPlayerFromHumanoidDescriptionRequest On DevHub

Parameters	2

Name	Type	Default
humanoidDescription	Instance	none
name	string	none

Security	RobloxScriptSecurity

History

384 Add GuiService.InspectPlayerFromHumanoidDescriptionRequest

InspectPlayerFromUserId On DevHub

Parameters	1

Name	Type	Default
userId	int64	none

Return Type	null

History

573 Change ReturnType of GuiService.InspectPlayerFromUserId from void to null
384 Add GuiService.InspectPlayerFromUserId

InspectPlayerFromUserIdWithCtx On DevHub

Parameters	2

Name	Type	Default
userId	int64	none
ctx	string	none

Return Type	null
Security	RobloxScriptSecurity

History

573 Change ReturnType of GuiService.InspectPlayerFromUserIdWithCtx from void to null
394 Add GuiService.InspectPlayerFromUserIdWithCtx

InspectPlayerFromUserIdWithCtxRequest On DevHub

Parameters	2

Name	Type	Default
userId	int64	none
ctx	string	none

Security	RobloxScriptSecurity

History

394 Add GuiService.InspectPlayerFromUserIdWithCtxRequest

IsMemoryTrackerEnabled On DevHub

Parameters	0

Name	Type	Default
No parameters.

Return Type	bool
Security	RobloxScriptSecurity

History

298 Add GuiService.IsMemoryTrackerEnabled

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.

Value Type	bool
Category	Data
Can Load	false
Can Save	false

History

213 Change Tags of GuiService.IsModalDialog from [ReadOnly, NotReplicated] to [ReadOnly, NotReplicated, Deprecated]

Tags: [ReadOnly, NotReplicated, Deprecated]

IsTenFootInterface On DevHub

Parameters	0

Name	Type	Default
No parameters.

Return Type	bool

History

252 Change Security of GuiService.IsTenFootInterface from RobloxScriptSecurity to None
232 Add GuiService.IsTenFootInterface

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.

Value Type	bool
Category	Data
Can Load	false
Can Save	false

History

213 Change Tags of GuiService.IsWindows from [ReadOnly, NotReplicated] to [ReadOnly, NotReplicated, Deprecated]
67 Add GuiService.IsWindows
66 Remove GuiService.IsWindows
67 Add GuiService.IsWindows

Tags: [ReadOnly, NotReplicated, Deprecated]

KeyPressed On DevHub

Parameters	2

Name	Type	Default
key	string	none
modifiers	string	none

Security	RobloxScriptSecurity

MenuClosed On DevHub

Parameters	0

Name	Type	Default
No parameters.

History

213 Add GuiService.MenuClosed

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.

Value Type	bool
Category	Data
Can Load	false
Can Save	true

History

213 Add GuiService.MenuIsOpen

Tags: [ReadOnly, NotReplicated]

MenuOpened On DevHub

Parameters	0

Name	Type	Default
No parameters.

History

213 Add GuiService.MenuOpened

NativeClose On DevHub

Parameters	0

Name	Type	Default
No parameters.

Security	RobloxScriptSecurity

History

435 Add GuiService.NativeClose

NetworkPausedEnabledChanged On DevHub

Parameters	1

Name	Type	Default
enabled	bool	none

Security	RobloxScriptSecurity

History

398 Add GuiService.NetworkPausedEnabledChanged

Open9SliceEditor On DevHub

Parameters	1

Name	Type	Default
selectedImageObject	Instance	none

Security	RobloxScriptSecurity

History

487 Add GuiService.Open9SliceEditor

OpenBrowserWindow On DevHub

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

Parameters	1

Name	Type	Default
url	string	none

Return Type	null
Security	RobloxScriptSecurity

History

573 Change ReturnType of GuiService.OpenBrowserWindow from void to null
371 Change Tags of GuiService.OpenBrowserWindow from [] to [Deprecated]
83 Add GuiService.OpenBrowserWindow

Tags: [Deprecated]

OpenNativeOverlay On DevHub

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

Parameters	2

Name	Type	Default
title	string	none
url	string	none

Return Type	null
Security	RobloxScriptSecurity

History

573 Change ReturnType of GuiService.OpenNativeOverlay from void to null
371 Change Tags of GuiService.OpenNativeOverlay from [] to [Deprecated]
298 Add GuiService.OpenNativeOverlay

Tags: [Deprecated]

PreferredTransparency On DevHub

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

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.

Value Type	float
Category	Data
Can Load	false
Can Save	false

History

583 Add GuiService.PreferredTransparency

Tags: [Hidden, ReadOnly, NotReplicated]

PurchasePromptShown On DevHub

Parameters	0

Name	Type	Default
No parameters.

Security	RobloxScriptSecurity

History

561 Add GuiService.PurchasePromptShown

ReducedMotionEnabled On DevHub

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

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.

Value Type	bool
Category	Data
Can Load	false
Can Save	false

History

583 Add GuiService.ReducedMotionEnabled

Tags: [Hidden, ReadOnly, NotReplicated]

RemoveCenterDialog On DevHub

Parameters	1

Name	Type	Default
dialog	Instance	none

Return Type	null
Security	RobloxScriptSecurity

History

573 Change ReturnType of GuiService.RemoveCenterDialog from void to null

RemoveKey On DevHub

Parameters	1

Name	Type	Default
key	string	none

Return Type	null
Security	RobloxScriptSecurity

History

573 Change ReturnType of GuiService.RemoveKey from void to null
125 Add GuiService.RemoveKey

RemoveSelectionGroup On DevHub

Parameters	1

Name	Type	Default
selectionName	string	none

Return Type	null

History

573 Change ReturnType of GuiService.RemoveSelectionGroup from void to null
193 Add GuiService.RemoveSelectionGroup

RemoveSpecialKey On DevHub

Parameters	1

Name	Type	Default
key	SpecialKey	none

Return Type	null
Security	RobloxScriptSecurity

History

573 Change ReturnType of GuiService.RemoveSpecialKey from void to null
171 Add GuiService.RemoveSpecialKey

SafeZoneOffsetsChanged On DevHub

Parameters	0

Name	Type	Default
No parameters.

Security	RobloxScriptSecurity

History

339 Add GuiService.SafeZoneOffsetsChanged

Select On DevHub

Parameters	1

Name	Type	Default
selectionParent	Instance	none

Return Type	null

History

573 Change ReturnType of GuiService.Select from void to null
523 Change Security of GuiService.Select from RobloxScriptSecurity to None
519 Add GuiService.Select

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.

Value Type	GuiObject
Security	RobloxScriptSecurity
Category	Data
Can Load	false
Can Save	false

History

469 Change CanLoad of GuiService.SelectedCoreObject from true to false
469 Change Tags of GuiService.SelectedCoreObject from [NotReplicated] to [Hidden, NotReplicated]
329 Change ValueType of GuiService.SelectedCoreObject from Object to GuiObject
196 Add GuiService.SelectedCoreObject

Tags: [Hidden, NotReplicated]

SelectedObject On DevHub

Value Type	GuiObject
Category	Data
Can Load	true
Can Save	true

History

329 Change ValueType of GuiService.SelectedObject from Object to GuiObject
197 Change ReadSecurity of GuiService.SelectedObject from RobloxScriptSecurity to None
197 Change WriteSecurity of GuiService.SelectedObject from RobloxScriptSecurity to None
193 Add GuiService.SelectedObject

SendCoreUiNotification On DevHub

Parameters	2

Name	Type	Default
title	string	none
text	string	none

Return Type	null
Security	RobloxScriptSecurity

History

573 Change ReturnType of GuiService.SendCoreUiNotification from void to null
211 Add GuiService.SendCoreUiNotification

SendUIOcclusionMetricsForQueryRegion On DevHub

Parameters	3

Name	Type	Default
position	UDim2	none
size	UDim2	none
regionName	string	none

Return Type	null
Security	RobloxScriptSecurity

History

598 Add GuiService.SendUIOcclusionMetricsForQueryRegion

SetEmotesMenuOpen On DevHub

Parameters	1

Name	Type	Default
isOpen	bool	none

Return Type	null

History

573 Change ReturnType of GuiService.SetEmotesMenuOpen from void to null
381 Add GuiService.SetEmotesMenuOpen

SetGameplayPausedNotificationEnabled On DevHub

Parameters	1

Name	Type	Default
enabled	bool	none

Return Type	null

History

573 Change ReturnType of GuiService.SetGameplayPausedNotificationEnabled from void to null
398 Add GuiService.SetGameplayPausedNotificationEnabled

SetGlobalGuiInset On DevHub

Parameters	4

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

Return Type	null
Security	RobloxScriptSecurity

History

573 Change ReturnType of GuiService.SetGlobalGuiInset from void to null
91 Add GuiService.SetGlobalGuiInset
90 Remove GuiService.SetGlobalGuiInset
91 Add GuiService.SetGlobalGuiInset

SetHardwareSafeAreaInsets On DevHub

Parameters	4

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

Return Type	null
Security	RobloxScriptSecurity

History

573 Change ReturnType of GuiService.SetHardwareSafeAreaInsets from void to null
546 Add GuiService.SetHardwareSafeAreaInsets

SetInspectMenuEnabled On DevHub

Parameters	1

Name	Type	Default
enabled	bool	none

Return Type	null

History

573 Change ReturnType of GuiService.SetInspectMenuEnabled from void to null
384 Add GuiService.SetInspectMenuEnabled

SetMenuIsOpen On DevHub

Parameters	2

Name	Type	Default
open	bool	none
menuName	string	default

Return Type	null
Security	RobloxScriptSecurity

History

573 Change ReturnType of GuiService.SetMenuIsOpen from void to null
378 Change Parameters of GuiService.SetMenuIsOpen from (bool open) to (bool open, string menuName = default)
213 Add GuiService.SetMenuIsOpen

SetPurchasePromptIsShown On DevHub

Parameters	1

Name	Type	Default
isShown	bool	none

Return Type	null
Security	RobloxScriptSecurity

History

573 Change ReturnType of GuiService.SetPurchasePromptIsShown from void to null
561 Add GuiService.SetPurchasePromptIsShown

SetSafeZoneOffsets On DevHub

Parameters	4

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

Return Type	null
Security	RobloxScriptSecurity

History

573 Change ReturnType of GuiService.SetSafeZoneOffsets from void to null
339 Add GuiService.SetSafeZoneOffsets

SetTopbarInset On DevHub

Parameters	1

Name	Type	Default
topbarInset	Rect	none

Return Type	null
Security	RobloxScriptSecurity

History

591 Change Parameters of GuiService.SetTopbarInset from (Dictionary topbarInset) to (Rect topbarInset)
590 Add GuiService.SetTopbarInset

SetUiMessage On DevHub

Parameters	2

Name	Type	Default
msgType	UiMessageType	none
uiMessage	string	errorCode

Return Type	null
Security	LocalUserSecurity

History

573 Change ReturnType of GuiService.SetUiMessage from void to null
347 Change Parameters of GuiService.SetUiMessage from (UiMessageType msgType, string uiMessage) to (UiMessageType msgType, string uiMessage = errorCode)
182 Add GuiService.SetUiMessage

ShowLeaveConfirmation On DevHub

Parameters	0

Name	Type	Default
No parameters.

Security	RobloxScriptSecurity

History

162 Add GuiService.ShowLeaveConfirmation

ShowStatsBasedOnInputString On DevHub

Parameters	1

Name	Type	Default
input	string	none

Return Type	bool
Security	RobloxScriptSecurity

History

219 Add GuiService.ShowStatsBasedOnInputString

SpecialKeyPressed On DevHub

Parameters	2

Name	Type	Default
key	SpecialKey	none
modifiers	string	none

Security	RobloxScriptSecurity

ToggleFullscreen On DevHub

Parameters	0

Name	Type	Default
No parameters.

Return Type	null
Security	RobloxScriptSecurity

History

573 Change ReturnType of GuiService.ToggleFullscreen from void to null
201 Add GuiService.ToggleFullscreen

ToggleGuiIsVisibleForCaptures On DevHub

Parameters	1

Name	Type	Default
guiType	GuiType	none

Return Type	null
Security	RobloxScriptSecurity

History

587 Add GuiService.ToggleGuiIsVisibleForCaptures

ToggleGuiIsVisibleIfAllowed On DevHub

Parameters	1

Name	Type	Default
guiType	GuiType	none

Return Type	null
Security	RobloxScriptSecurity

History

573 Change ReturnType of GuiService.ToggleGuiIsVisibleIfAllowed from void to null
538 Add GuiService.ToggleGuiIsVisibleIfAllowed

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

Value Type	Rect
Category	Data
Can Load	false
Can Save	false

History

599 Change Tags of GuiService.TopbarInset from [Hidden, ReadOnly, NotReplicated] to [ReadOnly, NotReplicated]
591 Add GuiService.TopbarInset

Tags: [ReadOnly, NotReplicated]

TouchControlsEnabled On DevHub

Value Type	bool
Category	Data
Can Load	false
Can Save	false

History

493 Add GuiService.TouchControlsEnabled

UiMessageChanged On DevHub

Parameters	2

Name	Type	Default
msgType	UiMessageType	none
newUiMessage	string	none

Security	RobloxScriptSecurity

History

182 Add GuiService.UiMessageChanged

Removed members

EscapeKeyPressed

Parameters	0

Name	Type	Default
No parameters.

Security	RobloxScriptSecurity

History

304 Remove GuiService.EscapeKeyPressed

GamepadNavigationEnabled

Value Type	bool
Security	RobloxScriptSecurity
Category
Can Load	false
Can Save	false

History

201 Remove GuiService.GamepadNavigationEnabled
196 Add GuiService.GamepadNavigationEnabled

GetConnectorCount

Parameters	0

Name	Type	Default
No parameters.

Return Type	int
Security	RobloxScriptSecurity

History

213 Remove GuiService.GetConnectorCount
157 Add GuiService.GetConnectorCount

GetInstanceCount

Parameters	0

Name	Type	Default
No parameters.

Return Type	int
Security	RobloxScriptSecurity

History

213 Remove GuiService.GetInstanceCount
157 Add GuiService.GetInstanceCount

GetNativeViewFeatureList

Parameters	0

Name	Type	Default
No parameters.

Return Type	Dictionary
Security	RobloxScriptSecurity

History

303 Remove GuiService.GetNativeViewFeatureList
301 Add GuiService.GetNativeViewFeatureList

GetVoxelCount

Parameters	0

Name	Type	Default
No parameters.

Return Type	float
Security	RobloxScriptSecurity

History

213 Remove GuiService.GetVoxelCount
168 Change ReturnType of GuiService.GetVoxelCount from int to float
157 Add GuiService.GetVoxelCount

InspectPlayerFromUserIdRequest

Parameters	1

Name	Type	Default
userId	int64	none

Security	RobloxScriptSecurity

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.

Value Type	bool
Security	RobloxScriptSecurity
Category	Data
Can Load	false
Can Save	false

History

448 Remove GuiService.RenderHumanoidBillboards
447 Add GuiService.RenderHumanoidBillboards

Tags: [Hidden, NotReplicated]

RequestNativeView

Parameters	2

Name	Type	Default
url	string	none
featureType	int	none

Return Type	void
Security	RobloxScriptSecurity

History

303 Remove GuiService.RequestNativeView
301 Change Parameters of GuiService.RequestNativeView from (string url) to (string url, int featureType)
298 Add GuiService.RequestNativeView

ScreenGuiEnabled

Value Type	bool
Security	RobloxScriptSecurity
Category
Can Load	false
Can Save	false

History

304 Remove GuiService.ScreenGuiEnabled
244 Add GuiService.ScreenGuiEnabled

SendNotification

Parameters	5

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

Return Type	void
Security	RobloxScriptSecurity

History

190 Remove GuiService.SendNotification

SetErrorMessage

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

Parameters	1

Name	Type	Default
errorMessage	string	none

Return Type	void
Security	LocalUserSecurity

History

273 Remove GuiService.SetErrorMessage
272 Add GuiService.SetErrorMessage
273 Remove GuiService.SetErrorMessage
182 Change Tags of GuiService.SetErrorMessage from [] to [Deprecated]
157 Add GuiService.SetErrorMessage

Tags: [Deprecated]

SetGlobalSizeOffsetPixel

Parameters	2

Name	Type	Default
x	int	none
y	int	none

Return Type	void
Security	RobloxScriptSecurity

History

91 Remove GuiService.SetGlobalSizeOffsetPixel
90 Add GuiService.SetGlobalSizeOffsetPixel
91 Remove GuiService.SetGlobalSizeOffsetPixel

ShowAppShellTabBar

Parameters	1

Name	Type	Default
value	bool	none

Return Type	void
Security	RobloxScriptSecurity

History

303 Remove GuiService.ShowAppShellTabBar
300 Add GuiService.ShowAppShellTabBar

ShowLegacyPlayerList

Value Type	bool
Security	RobloxScriptSecurity
Category
Can Load	false
Can Save	false

History

213 Remove GuiService.ShowLegacyPlayerList

TopbarInsetChanged

Parameters	1

Name	Type	Default
topbarInset	Dictionary	none

History

591 Remove GuiService.TopbarInsetChanged
590 Add GuiService.TopbarInsetChanged

UseLuaChat

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

Value Type	bool
Category
Can Load	false
Can Save	false

History

Tags: [ReadOnly]

Version

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

Value Type	double
Category
Can Load	false
Can Save	false