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

Memory Category	Instances
ExplorerImageIndex	46 ()
ExplorerOrder	30

Tags: [NotCreatable, Service]

Inherits (2)

Member index (13)

Type	Member	History
bool	ProcessUserInput	338
bool	ResetPlayerGuiOnSpawn	123 206 301
RtlTextSupport	RtlTextSupport	564
ScreenOrientation	ScreenOrientation	290
bool	ShowDevelopmentGui
VirtualCursorMode	VirtualCursorMode	479
Variant	GetCore (string parameterName)	210
bool	GetCoreGuiEnabled (CoreGuiType coreGuiType)	124
void	RegisterGetCore (string parameterName, Function getFunction)	210
void	RegisterSetCore (string parameterName, Function setFunction)	210
void	SetCore (string parameterName, Variant value)	210
void	SetCoreGuiEnabled (CoreGuiType coreGuiType, bool enabled)	124
	CoreGuiChangedSignal (CoreGuiType coreGuiType, bool enabled)	124
2 members inherited from BasePlayerGui
51 members inherited from Instance

Removed member index (4)

Type	Member	History
bool	BackpackGuiEnabled	113 124
bool	HealthGuiEnabled	113 124
bool	PlayerListGuiEnabled	113 124
bool	ResetPlayerGuiOnDeath	113 123

564 Add StarterGui.RtlTextSupport
479 Add StarterGui.VirtualCursorMode
338 Add StarterGui.ProcessUserInput
301 Change Tags of StarterGui.ResetPlayerGuiOnSpawn from [] to [Deprecated]
290 Add StarterGui.ScreenOrientation
210 Add StarterGui.GetCore
210 Add StarterGui.RegisterGetCore
210 Add StarterGui.RegisterSetCore
210 Add StarterGui.SetCore
206 Change Tags of StarterGui.ResetPlayerGuiOnSpawn from [Hidden] to []
124 Remove StarterGui.BackpackGuiEnabled
124 Remove StarterGui.HealthGuiEnabled
124 Remove StarterGui.PlayerListGuiEnabled
124 Add StarterGui.GetCoreGuiEnabled
124 Add StarterGui.SetCoreGuiEnabled
124 Add StarterGui.CoreGuiChangedSignal
123 Remove StarterGui.ResetPlayerGuiOnDeath
123 Add StarterGui.ResetPlayerGuiOnSpawn
113 Add StarterGui.BackpackGuiEnabled
113 Add StarterGui.HealthGuiEnabled
113 Add StarterGui.PlayerListGuiEnabled
113 Add StarterGui.ResetPlayerGuiOnDeath
55 Change Tags of StarterGui from [preliminary, NotCreatable, Service] to [NotCreatable, Service]

Members

CoreGuiChangedSignal On DevHub

Parameters	2

Name	Type	Default
coreGuiType	CoreGuiType	none
enabled	bool	none

Security	RobloxScriptSecurity

History

124 Add StarterGui.CoreGuiChangedSignal

GetCore On DevHub

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

Parameters	1

Name	Type	Default
parameterName	string	none

Return Type	Variant

History

210 Add StarterGui.GetCore

Tags: [Yields]

GetCoreGuiEnabled On DevHub

Parameters	1

Name	Type	Default
coreGuiType	CoreGuiType	none

Return Type	bool

History

124 Add StarterGui.GetCoreGuiEnabled

ProcessUserInput 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
Security	PluginSecurity
Category	Behavior
Can Load	false
Can Save	false

History

338 Add StarterGui.ProcessUserInput

Tags: [Hidden, NotReplicated]

RegisterGetCore On DevHub

Parameters	2

Name	Type	Default
parameterName	string	none
getFunction	Function	none

Return Type	void
Security	RobloxScriptSecurity

History

210 Add StarterGui.RegisterGetCore

RegisterSetCore On DevHub

Parameters	2

Name	Type	Default
parameterName	string	none
setFunction	Function	none

Return Type	void
Security	RobloxScriptSecurity

History

210 Add StarterGui.RegisterSetCore

ResetPlayerGuiOnSpawn On DevHub

Globally controls the resetting behavior of LayerCollectors under the PlayerGui.

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

Value Type	bool
Category	Data
Can Load	true
Can Save	true

When ResetPlayerGuiOnSpawn is true (the default), a LayerCollector under the PlayerGui will reset if its ResetOnSpawn property is also true. When ResetPlayerGuiOnSpawn is false, LayerCollectors will never reset, regardless of their ResetOnSpawn property.

ResetPlayerGuiOnSpawn is deprecated. To suppress the resetting behavior of a LayerCollector, its ResetOnSpawn property should explicitly be set to false.

History

301 Change Tags of StarterGui.ResetPlayerGuiOnSpawn from [] to [Deprecated]
206 Change Tags of StarterGui.ResetPlayerGuiOnSpawn from [Hidden] to []
123 Add StarterGui.ResetPlayerGuiOnSpawn

Tags: [Deprecated]

RtlTextSupport On DevHub

This member is not scriptable. It cannot be accessed by Lua code.

Value Type	RtlTextSupport
Category	Behavior
Can Load	true
Can Save	true

History

564 Add StarterGui.RtlTextSupport

Tags: [NotScriptable]

ScreenOrientation On DevHub

Value Type	ScreenOrientation
Category	Data
Can Load	true
Can Save	true

History

290 Add StarterGui.ScreenOrientation

SetCore On DevHub

Parameters	2

Name	Type	Default
parameterName	string	none
value	Variant	none

Return Type	void

History

210 Add StarterGui.SetCore

SetCoreGuiEnabled On DevHub

Parameters	2

Name	Type	Default
coreGuiType	CoreGuiType	none
enabled	bool	none

Return Type	void

History

124 Add StarterGui.SetCoreGuiEnabled

ShowDevelopmentGui On DevHub

Value Type	bool
Category	Data
Can Load	true
Can Save	true

VirtualCursorMode On DevHub

This member is not scriptable. It cannot be accessed by Lua code.

Value Type	VirtualCursorMode
Category	Behavior
Can Load	true
Can Save	true

History

479 Add StarterGui.VirtualCursorMode

Tags: [NotScriptable]

Removed members

BackpackGuiEnabled

This member is hidden. It is not meant to be used, and may have unresolved issues.

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

History

124 Remove StarterGui.BackpackGuiEnabled
113 Add StarterGui.BackpackGuiEnabled

Tags: [Hidden]

HealthGuiEnabled

This member is hidden. It is not meant to be used, and may have unresolved issues.

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

History

124 Remove StarterGui.HealthGuiEnabled
113 Add StarterGui.HealthGuiEnabled

Tags: [Hidden]

PlayerListGuiEnabled

This member is hidden. It is not meant to be used, and may have unresolved issues.

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

History

124 Remove StarterGui.PlayerListGuiEnabled
113 Add StarterGui.PlayerListGuiEnabled

Tags: [Hidden]

ResetPlayerGuiOnDeath

This member is hidden. It is not meant to be used, and may have unresolved issues.

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

History

123 Remove StarterGui.ResetPlayerGuiOnDeath
113 Add StarterGui.ResetPlayerGuiOnDeath

Tags: [Hidden]