StarterGui

StarterGui : Instance

Overview

The given statements collectively describe a code snippet defining a class StarterGui derived from Instance. This class is designed to manage and control the visibility of core Graphical User Interface (GUI) elements in a game developed using either Unreal Engine or RoboLox (although Unreal-specific references were more prevalent). The code provides functionalities for managing enabling and disabling of these core GUI elements, which can be accessed through methods like GetCoreGuiEnabled and SetCoreGuiEnabled. These methods interact with the Enum.CoreGuiType enumeration to handle specific

Description

StarterGui is a Lua API reference in Overdare Studio. It extends from the Instance base class and enables developers to interact with and manage core user interface elements within their projects using Lua scripting language. The API provides methods like GetCoreGuiEnabled() and SetCoreGuiEnabled(), allowing control over enabling or disabling specific CoreGUI types in Overdare Studio development. This enhances customizability and helps create tailored, dynamic user experiences based on developers' requirements.

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