StarterGui
Stores interface templates copied to PlayerGui on spawn.
- Service
game:GetService("StarterGui")- Inherits
- Instance
- Replication
- Never
Behavior
StarterGui contains interface templates copied into each player's
PlayerGui on spawn. Runtime changes affect future copies.
Change the player's PlayerGui to update an existing interface.
Summary
Whether PlayerGui is cleared and copied from this template on each spawn.
Reads a named setting exposed by the built-in interface.
Returns whether the specified built-in interface panel is enabled.
Returns this instance if it is an ExecutionGroup.
Registers a callback that supplies a named built-in interface setting.
Registers a callback that handles writes to a named built-in interface setting.
Requests a named action from the built-in interface.
Adds a system message to the built-in chat window.
Writes a named setting exposed by the built-in interface.
Shows or hides a built-in interface panel identified by Enum.CoreGuiType.
Sets a named built-in interface setting.
Properties
ResetPlayerGuiOnSpawn
StarterGui.ResetPlayerGuiOnSpawn: boolean = trueWhether PlayerGui is cleared and copied from this template on each spawn. Individual screens also expose ScreenGui.ResetOnSpawn.
Methods
GetCore
StarterGui:GetCore(parameterName: string): anyReads a named setting exposed by the built-in interface.
GetCoreGuiEnabled
StarterGui:GetCoreGuiEnabled(value: EnumItem): booleanReturns whether the specified built-in interface panel is enabled.
GetExecutionGroup
StarterGui:GetExecutionGroup(): ExecutionGroup?Returns this instance if it is an ExecutionGroup. Otherwise returns the nearest ancestor ExecutionGroup, or nil when no group contains the instance.
RegisterGetCore
StarterGui:RegisterGetCore(name: string, callback: () -> any): ()Registers a callback that supplies a named built-in interface setting.
RegisterSetCore
StarterGui:RegisterSetCore(name: string, callback: (value: any) -> ()): ()Registers a callback that handles writes to a named built-in interface setting.
RequestCoreAction
StarterGui:RequestCoreAction(action: string): ()Requests a named action from the built-in interface.
SendCoreChatMessage
StarterGui:SendCoreChatMessage(message: string): ()Adds a system message to the built-in chat window.
SetCore
StarterGui:SetCore(parameterName: string, value: any): ()Writes a named setting exposed by the built-in interface.
SetCoreGuiEnabled
StarterGui:SetCoreGuiEnabled(coreGuiType: EnumItem, enabled: boolean): ()Shows or hides a built-in interface panel identified by Enum.CoreGuiType. Available on the client.
SetCoreSetting
StarterGui:SetCoreSetting(name: string, value: boolean | number | string): ()Sets a named built-in interface setting.
Inherited members
- Properties
- ArchivableClassNameNameParent
- Methods
- AddComponent()AddTag()ClearAllChildren()ClearTags()Clone()Destroy()FindFirstAncestor()FindFirstAncestorOfClass()FindFirstAncestorWhichIsA()FindFirstChild()FindFirstChildOfClass()FindFirstChildWhichIsA()FindFirstDescendant()GetAttribute()GetAttributeChangedSignal()GetAttributes()GetChildren()GetComponent()GetComponentChangedSignal()GetComponents()GetDebugId()GetDescendants()GetFullName()GetPropertyChangedSignal()GetReferencing()GetTags()HasComponent()HasTag()IsA()IsAncestorOf()IsDescendantOf()RemoveComponent()RemoveTag()SetAttribute()WaitForChild()
- Events
- AncestryChangedAttributeChangedChangedChildAddedChildRemovedDescendantAddedDescendantRemovingDestroying
Example
local StarterGui = game:GetService("StarterGui")
StarterGui:SetCoreGuiEnabled(Enum.CoreGuiType.Backpack, false)