Frame

Frame : GuiObject

Overview

Frame is a base container UI object that is used to structurally bind a variety of GUI elements.

Frame in particular, is suitable when creating a reactive UI layout. Because it supports all the basic GUI elements, background color, transparency, and other styles can be freely customized.

Frame can be controlled only in client environment.

Properties

BorderColor3

Color3

Sets the color of the Frame's border.

If BorderPixelSize is 0, this property has no visual effect regardless of the value assigned.

Code Samples

local Frame = script.Parent

Frame.BorderColor3 = Color3.fromRGB(220, 50, 50)

BorderMode

Enum.BorderMode

Determines how the border is rendered relative to the Frame's boundary.

Controls which direction the border extends from the Frame's edge, which may affect overlap and spatial calculations with other UI elements in a layout.

Code Samples

local Frame = script.Parent

Frame.BorderMode = Enum.BorderMode.Inset

BorderPixelSize

number

Specifies the thickness of the Frame's border in pixels.

Setting this value to 0 disables border rendering entirely. Integer values are recommended; negative values are not allowed.

Code Samples

local Frame = script.Parent

Frame.BorderPixelSize = 3

Methods

Events

See also

GUI