StarterGui

StarterGui : Instance

Overview

The default GUI container for storing UI elements such as ScreenGui that will be displayed on the player's screen

Each time a player's character is spawned in the game, all UI elements inside StarterGui are copied into that player's PlayerGui, removing and replacing any previously copied UI.

StarterGui also provides functionality for controlling CoreGui elements like the joystick and jump button.

Properties

Methods

GetCoreGuiEnabled

Returns the visibility status of the specified CoreGui.

Parameters

Enum.CoreGuiType CoreGuiType	This is the target CoreGui.

Return

boolean	Whether the specified CoreGui is currently visible.

Code Samples

local StarterGui = game:GetService("StarterGui")

local IsChatEnabled = StarterGui:GetCoreGuiEnabled(Enum.CoreGuiType.Chat)
print(IsChatEnabled)

SetCoreGuiEnabled

Sets the visibility of the specified CoreGui.

Parameters

Enum.CoreGuiType CoreGuiType	This is the target CoreGui.
boolean Enabled	This is the visibility status.

Return

void

Code Samples

local StarterGui = game:GetService("StarterGui")

StarterGui:SetCoreGuiEnabled(Enum.CoreGuiType.Chat, false)

Events

See also

Mobile Input Handling