StarterGui

StarterGui : Instance

Overview

Properties

Methods

GetCoreGuiEnabled

The GetCoreGuiEnabled method checks if a specific core GUI type is enabled and returns a boolean value indicating the status. It accepts an input of type "Enum.CoreGuiType" named "CoreGuiType" to determine whether this core GUI element is enabled or not.

Parameters

Enum.CoreGuiType CoreGuiType

Return

bool

Code Samples

local StarterGui = game:GetService("StarterGui")

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

SetCoreGuiEnabled

The "SetCoreGuiEnabled" method, present in a header file, accepts two parameters - an enum of type Enum.CoreGuiType and a boolean value for enabling or disabling specific Lua CoreGuiTypes without returning any output. This method toggles the enabled state for a specified core GUI element based on the provided type and boolean value.

Parameters

Enum.CoreGuiType CoreGuiType
bool Enabled

Return

void

Code Samples

local StarterGui = game:GetService("StarterGui")

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

Events

See also

Mobile Input Handling