StarterGui

StarterGui
Not creatableThis class cannot be instantiated. ServiceThis class is a service.
Icon
Legacy IconsThese icon(s) are only a part of legacy Roblox Studio versions, or are unused as of the studio icons update.
Added in	20
Memory category	Instances
Inheritance
Object Instance BasePlayerGui StarterGui

The StarterGui class inherits from BasePlayerGui. It holds ScreenGui objects which are then placed in the player's PlayerGui when they join the game.

Properties

ProcessUserInput: bool

• HiddenThis property is not shown in the object browser and properties window.
• Not replicatedThis member is not replicated across the network boundary.

This class member is missing documentation. Create or add to its subpage at Class:StarterGui/ProcessUserInput.

• Category: Behavior.
• Read security: PluginSecurity.
• Write security: PluginSecurity.
• Serialization: cannot load or save.
• Thread safety: read safe

ResetPlayerGuiOnSpawn: bool

• DeprecatedThis member will be phased out and should be avoided while it is still available.

When true, all children of StarterGui is cloned into a Player's PlayerGui when a character is spawned. This property is deprecated, this behavior can instead be controlled individually by setting LayerCollector.ResetOnSpawn.

• Category: Data.
• Serialization: can save and load.
• Thread safety: read safe

RtlTextSupport: RtlTextSupport

• Not scriptableThis member cannot be accessed by Lua code.

This class member is missing documentation. Create or add to its subpage at Class:StarterGui/RtlTextSupport.

• Category: Behavior.
• Serialization: can save and load.
• Thread safety: read safe

ScreenOrientation: ScreenOrientation

This class member is missing documentation. Create or add to its subpage at Class:StarterGui/ScreenOrientation.

• Category: Data.
• Serialization: can save and load.
• Thread safety: read safe

ShowDevelopmentGui: bool

This API member has existing documentation in this page's Member list template.

This class member is missing documentation. Create or add to its subpage at Class:StarterGui/ShowDevelopmentGui.

• Category: Data.
• Serialization: can save and load.
• Thread safety: read safe

StudioDefaultStyleSheet: StyleSheet

• HiddenThis property is not shown in the object browser and properties window.

This class member is missing documentation. Create or add to its subpage at Class:StarterGui/StudioDefaultStyleSheet.

• Category: Data.
• Read security: RobloxScriptSecurity.
• Write security: RobloxScriptSecurity.
• Serialization: can save and load.
• Thread safety: read safe

StudioInsertWidgetLayerCollectorAutoLinkStyleSheet: StyleSheet

• HiddenThis property is not shown in the object browser and properties window.

This class member is missing documentation. Create or add to its subpage at Class:StarterGui/StudioInsertWidgetLayerCollectorAutoLinkStyleSheet.

• Category: Data.
• Read security: RobloxScriptSecurity.
• Write security: RobloxScriptSecurity.
• Serialization: can save and load.
• Thread safety: read safe

VirtualCursorMode: VirtualCursorMode

• Not scriptableThis member cannot be accessed by Lua code.

This class member is missing documentation. Create or add to its subpage at Class:StarterGui/VirtualCursorMode.

• Category: Behavior.
• Serialization: can save and load.
• Thread safety: read safe

Methods

GetCore(parameterName: string): Variant

• YieldsThis function can yield the script it is used in.

Parameters

Name	Type
parameterName	string

• Thread safety: unsafe

GetCoreGuiEnabled(coreGuiType: CoreGuiType): bool

Parameters

Name	Type
coreGuiType	CoreGuiType

• Thread safety: unsafe

RegisterGetCore(parameterName: string, getFunction: Function): null

Parameters

Name	Type
parameterName	string
getFunction	Function

• Security: RobloxScriptSecurity.
• Thread safety: unsafe

RegisterSetCore(parameterName: string, setFunction: Function): null

Parameters

Name	Type
parameterName	string
setFunction	Function

• Security: RobloxScriptSecurity.
• Thread safety: unsafe

SetCore(parameterName: string, value: Variant): null

Parameters

Name	Type
parameterName	string
value	Variant

• Thread safety: unsafe

SetCoreGuiEnabled(coreGuiType: CoreGuiType, enabled: bool): null

Parameters

Name	Type
coreGuiType	CoreGuiType
enabled	bool

• Thread safety: unsafe

Events

CoreGuiChangedSignal(coreGuiType: CoreGuiType, enabled: bool)

Parameters

Name	Type
coreGuiType	CoreGuiType
enabled	bool

• Security: RobloxScriptSecurity.
• Thread safety: unsafe

Removed members

Properties

• BackpackGuiEnabled
• HealthGuiEnabled
• PlayerListGuiEnabled
• ResetPlayerGuiOnDeath

External links

• StarterGui in the Roblox Creator Documentation
• StarterGui in the Roblox API Reference