GuiObject

GuiObject : GuiBase2d

Overview

Properties

Active

bool

Active indicates whether a specific GUI element is active, enabled for interaction, or visibly present

Code Samples

Position

UDim2

Specifies where the GUI element is placed on the screen.

Code Samples

local ScreenGui = script.Parent
local TextLabel = ScreenGui.TextLabel

TextLabel.Position = UDim2.new(0.5, 0, 0.5, 0)

Rotation

number

Rotation represents the degree of rotation applied to these GUI object

Code Samples

local ScreenGui = script.Parent
local TextLabel = ScreenGui.TextLabel

TextLabel.Rotation = 90

Size

UDim2

Determines the size of the GUI element.

Code Samples

local ScreenGui = script.Parent
local TextLabel = ScreenGui.TextLabel

TextLabel.Size = UDim2.new(1, 0, 0.5, 0)

Visible

bool

Visible determines whether the GUI element is displayed (true) or hidden (false) on the screen. A hidden GUI element ( Visible set to false) will not be rendered but may still exist in the hierarchy and its properties can be accessed or modified.

Code Samples

local ScreenGui = script.Parent
local TextLabel = ScreenGui.TextLabel

TextLabel.Visible = false

AnchorPoint

Vector2

AnchorPoint determines the pivot point of the GUI object relative to its position. The value is a Vector2, where (0,0) corresponds to the top-left corner, and (1,1) corresponds to the bottom-right corner. Adjusting the anchor point is useful for aligning GUI elements at specific positions without manually recalculating their placement.

Code Samples

local ScreenGui = script.Parent
local TextLabel = ScreenGui.TextLabel

print(TextLabel.AnchorPoint)

ZIndex

number

ZIndex determines the rendering order of GUI elements. GUI elements with higher ZIndex values will appear above elements with lower ZIndex values, allowing you to control the layering of UI components. This property is particularly useful when designing complex user interfaces with overlapping elements.

Code Samples

local ScreenGui = script.Parent
local TextLabel = ScreenGui.TextLabel

print(TextLabel.ZIndex)

BackgroundColor3

Color3

BackgroundColor3 is a property that determines the background color of the GUI object. It is a Color3 value that allows you to specify colors using RGB (red, green, blue) values. By adjusting this property, you can customize the appearance of your GUI element to complement the overall design of your interface.

The value can be set using Color3.new(r, g, b), where r, g, and b are numbers ranging from 0 to 1, or using predefined Color3 values.

Code Samples

BackgroundTransparency

number

BackgroundTransparency determines the transparency level of the background of the GUI object. It is a number value that ranges from 0 (completely opaque) to 1 (completely transparent). By setting this property, you can control the visibility of the background, allowing for more versatile designs.

Code Samples

local ScreenGui = script.Parent
local TextLabel = ScreenGui.TextLabel

TextLabel.BackgroundTransparency = 0.7

Methods

Events

InputBegan

Fires when the user starts interacting with a GuiObject using any input device.

Parameters

InputObject InputObject	The input object containing data about the change in input.

Code Samples

local ScreenGui = script.Parent
local TextButton = ScreenGui:WaitForChild("TextButton")

local function OnInputBegan(input)
    local keyCode = input.KeyCode
    local inputState = input.UserInputState
    local inputType = input.UserInputType
    local delta = input.Delta
    local pos = input.Position 
end
TextButton.InputBegan:Connect(OnInputBegan)

InputChanged

Fires when the user modifies their interaction with a GuiObject via an input device.

Parameters

InputObject InputObject	The input object containing data about the change in input.

Code Samples

local ScreenGui = script.Parent
local TextButton = ScreenGui:WaitForChild("TextButton")

local function OnInputChanged(input)
    local keyCode = input.KeyCode
    local inputState = input.UserInputState
    local inputType = input.UserInputType
    local delta = input.Delta
    local pos = input.Position 
end
TextButton.InputChanged:Connect(OnInputChanged)

InputEnded

Fires when the user ends their interaction with a GuiObject via an input device

Parameters

InputObject InputObject	The input object containing data about the change in input.

Code Samples

local ScreenGui = script.Parent
local TextButton = ScreenGui:WaitForChild("TextButton")

local function OnInputEnded(input)
    local keyCode = input.KeyCode
    local inputState = input.UserInputState
    local inputType = input.UserInputType
    local delta = input.Delta
    local pos = input.Position 
end
TextButton.InputEnded:Connect(OnInputEnded)