GuiObject

GuiObject
Not creatableThis class cannot be instantiated. Not browsableThis class is not visible in documentation for end-users.
Memory category	Gui
Subclasses
Inheritance
Instance GuiBase GuiBase2d GuiObject

The GuiObject class inherits from GuiBase2d. It is a structural class to which all the properties and methods that are common to all GUI classes belong. These classes include Frame, GuiButton, GuiLabel, ImageButton, and ImageLabel.

Properties

Active: bool

This API member has existing documentation in this page's Member list template.

This class member is missing documentation. Create or add to its subpage at Class:GuiObject/Active.

• Category: Data.
• Serialization: can save and load.
• Thread safety: read safe

AnchorPoint: Vector2

This class member is missing documentation. Create or add to its subpage at Class:GuiObject/AnchorPoint.

• Category: Data.
• Serialization: can save and load.
• Thread safety: read safe

AutomaticSize: AutomaticSize

This class member is missing documentation. Create or add to its subpage at Class:GuiObject/AutomaticSize.

• Category: Data.
• Serialization: can save and load.
• Thread safety: read safe

BackgroundColor: BrickColor

• HiddenThis property is not shown in the object browser and properties window.
• Not replicatedThis member is not replicated across the network boundary.
• DeprecatedThis member will be phased out and should be avoided while it is still available.

This API member has existing documentation in this page's Member list template.

This class member is missing documentation. Create or add to its subpage at Class:GuiObject/BackgroundColor.

• Category: Data.
• Serialization: can load only.
• Thread safety: read safe

BackgroundColor3: Color3

This API member has existing documentation in this page's Member list template.

This class member is missing documentation. Create or add to its subpage at Class:GuiObject/BackgroundColor3.

• Category: Data.
• Serialization: can save and load.
• Thread safety: read safe

BackgroundTransparency: float

The background transparency of the GuiObject.

• Category: Data.
• Serialization: can save and load.
• Thread safety: read safe

BorderColor: BrickColor

• HiddenThis property is not shown in the object browser and properties window.
• Not replicatedThis member is not replicated across the network boundary.
• DeprecatedThis member will be phased out and should be avoided while it is still available.

This API member has existing documentation in this page's Member list template.

This class member is missing documentation. Create or add to its subpage at Class:GuiObject/BorderColor.

• Category: Data.
• Serialization: can load only.
• Thread safety: read safe

BorderColor3: Color3

Indicates the color of the border surrounding the GUI object. This value will be overridden by UIStroke objects.

• Category: Data.
• Serialization: can save and load.
• Thread safety: read safe

BorderMode: BorderMode

This class member is missing documentation. Create or add to its subpage at Class:GuiObject/BorderMode.

• Category: Data.
• Serialization: can save and load.
• Thread safety: read safe

BorderSizePixel: int

Indicates the thickness of the GUI object's border.

• Category: Data.
• Serialization: can save and load.
• Thread safety: read safe

ClipsDescendants: bool

This API member has existing documentation in this page's Member list template.

This class member is missing documentation. Create or add to its subpage at Class:GuiObject/ClipsDescendants.

• Category: Behavior.
• Serialization: can save and load.
• Thread safety: read safe

Draggable: bool

• DeprecatedThis member will be phased out and should be avoided while it is still available.

This API member has existing documentation in this page's Member list template.

This class member is missing documentation. Create or add to its subpage at Class:GuiObject/Draggable.

• Category: Behavior.
• Serialization: can save and load.
• Thread safety: read safe

GuiState: GuiState

• Read-onlyThis property is capable of being read but not written.
• Not replicatedThis member is not replicated across the network boundary.

This class member is missing documentation. Create or add to its subpage at Class:GuiObject/GuiState.

• Category: State.
• Serialization: can save only.
• Thread safety: read safe

Interactable: bool

Indicates whether or not this object and its descendants can be interacted with.

• Category: Data.
• Serialization: can save and load.
• Thread safety: read safe

LayoutOrder: int

This class member is missing documentation. Create or add to its subpage at Class:GuiObject/LayoutOrder.

• Category: Data.
• Serialization: can save and load.
• Thread safety: read safe

NextSelectionDown: GuiObject

This API member has existing documentation in this page's Member list template.

This class member is missing documentation. Create or add to its subpage at Class:GuiObject/NextSelectionDown.

• Category: Selection.
• Serialization: can save and load.
• Thread safety: read safe

NextSelectionLeft: GuiObject

This API member has existing documentation in this page's Member list template.

This class member is missing documentation. Create or add to its subpage at Class:GuiObject/NextSelectionLeft.

• Category: Selection.
• Serialization: can save and load.
• Thread safety: read safe

NextSelectionRight: GuiObject

This API member has existing documentation in this page's Member list template.

This class member is missing documentation. Create or add to its subpage at Class:GuiObject/NextSelectionRight.

• Category: Selection.
• Serialization: can save and load.
• Thread safety: read safe

NextSelectionUp: GuiObject

This API member has existing documentation in this page's Member list template.

This class member is missing documentation. Create or add to its subpage at Class:GuiObject/NextSelectionUp.

• Category: Selection.
• Serialization: can save and load.
• Thread safety: read safe

Position: UDim2

This API member has existing documentation in this page's Member list template.

This class member is missing documentation. Create or add to its subpage at Class:GuiObject/Position.

• Category: Data.
• Serialization: can save and load.
• Thread safety: read safe

Rotation: float

This API member has existing documentation in this page's Member list template.

This class member is missing documentation. Create or add to its subpage at Class:GuiObject/Rotation.

• Category: Data.
• Serialization: can save and load.
• Thread safety: read safe

Selectable: bool

This API member has existing documentation in this page's Member list template.

This class member is missing documentation. Create or add to its subpage at Class:GuiObject/Selectable.

• Category: Selection.
• Serialization: can save and load.
• Thread safety: read safe

SelectionImageObject: GuiObject

This API member has existing documentation in this page's Member list template.

This class member is missing documentation. Create or add to its subpage at Class:GuiObject/SelectionImageObject.

• Category: Appearance.
• Serialization: can save and load.
• Thread safety: read safe

SelectionOrder: int

This class member is missing documentation. Create or add to its subpage at Class:GuiObject/SelectionOrder.

• Category: Selection.
• Serialization: can save and load.
• Thread safety: read safe

Size: UDim2

This API member has existing documentation in this page's Member list template.

This class member is missing documentation. Create or add to its subpage at Class:GuiObject/Size.

• Category: Data.
• Serialization: can save and load.
• Thread safety: read safe

SizeConstraint: SizeConstraint

This API member has existing documentation in this page's Member list template.

This class member is missing documentation. Create or add to its subpage at Class:GuiObject/SizeConstraint.

• Category: Data.
• Serialization: can save and load.
• Thread safety: read safe

Transparency: float

• HiddenThis property is not shown in the object browser and properties window.
• Not replicatedThis member is not replicated across the network boundary.

This class member is missing documentation. Create or add to its subpage at Class:GuiObject/Transparency.

• Category: Data.
• Serialization: can load only.
• Thread safety: read safe

Visible: bool

Indicates whether or not the GUI object can be seen and interacted with by the client.

• Category: Data.
• Serialization: can save and load.
• Thread safety: read safe

ZIndex: int

This API member has existing documentation in this page's Member list template.

This class member is missing documentation. Create or add to its subpage at Class:GuiObject/ZIndex.

• Category: Data.
• Serialization: can save and load.
• Thread safety: read safe

Methods

TweenPosition(endPosition: UDim2, easingDirection: EasingDirection = Out, easingStyle: EasingStyle = Quad, time: float = 1, override: bool = false, callback: Function = nil): bool

Parameters

Name	Type	Default
endPosition	UDim2
easingDirection	EasingDirection	Out
easingStyle	EasingStyle	Quad
time	float	1
override	bool	false
callback	Function	nil

• Thread safety: unsafe

TweenSize(endSize: UDim2, easingDirection: EasingDirection = Out, easingStyle: EasingStyle = Quad, time: float = 1, override: bool = false, callback: Function = nil): bool

Parameters

Name	Type	Default
endSize	UDim2
easingDirection	EasingDirection	Out
easingStyle	EasingStyle	Quad
time	float	1
override	bool	false
callback	Function	nil

• Thread safety: unsafe

TweenSizeAndPosition(endSize: UDim2, endPosition: UDim2, easingDirection: EasingDirection = Out, easingStyle: EasingStyle = Quad, time: float = 1, override: bool = false, callback: Function = nil): bool

Parameters

Name	Type	Default
endSize	UDim2
endPosition	UDim2
easingDirection	EasingDirection	Out
easingStyle	EasingStyle	Quad
time	float	1
override	bool	false
callback	Function	nil

• Thread safety: unsafe

Events

DragBegin(initialPosition: UDim2)

• DeprecatedThis member will be phased out and should be avoided while it is still available.

Parameters

Name	Type
initialPosition	UDim2

• Thread safety: unsafe

DragStopped(x: int, y: int)

• DeprecatedThis member will be phased out and should be avoided while it is still available.

Parameters

Name	Type
x	int
y	int

• Thread safety: unsafe

InputBegan(input: InputObject)

Parameters

Name	Type
input	InputObject

• Thread safety: unsafe

InputChanged(input: InputObject)

Parameters

Name	Type
input	InputObject

• Thread safety: unsafe

InputEnded(input: InputObject)

Parameters

Name	Type
input	InputObject

• Thread safety: unsafe

MouseEnter(x: int, y: int)

Parameters

Name	Type
x	int
y	int

• Thread safety: unsafe

MouseLeave(x: int, y: int)

Parameters

Name	Type
x	int
y	int

• Thread safety: unsafe

MouseMoved(x: int, y: int)

Parameters

Name	Type
x	int
y	int

• Thread safety: unsafe

MouseWheelBackward(x: int, y: int)

Parameters

Name	Type
x	int
y	int

• Thread safety: unsafe

MouseWheelForward(x: int, y: int)

Parameters

Name	Type
x	int
y	int

• Thread safety: unsafe

SelectionGained()

This class member is missing documentation. Create or add to its subpage at Class:GuiObject/SelectionGained.

• Thread safety: unsafe

SelectionLost()

This class member is missing documentation. Create or add to its subpage at Class:GuiObject/SelectionLost.

• Thread safety: unsafe

TouchLongPress(touchPositions: Array, state: UserInputState)

Parameters

Name	Type
touchPositions	Array
state	UserInputState

• Thread safety: unsafe

TouchPan(touchPositions: Array, totalTranslation: Vector2, velocity: Vector2, state: UserInputState)

Parameters

Name	Type
touchPositions	Array
totalTranslation	Vector2
velocity	Vector2
state	UserInputState

• Thread safety: unsafe

TouchPinch(touchPositions: Array, scale: float, velocity: float, state: UserInputState)

Parameters

Name	Type
touchPositions	Array
scale	float
velocity	float
state	UserInputState

• Thread safety: unsafe

TouchRotate(touchPositions: Array, rotation: float, velocity: float, state: UserInputState)

Parameters

Name	Type
touchPositions	Array
rotation	float
velocity	float
state	UserInputState

• Thread safety: unsafe

TouchSwipe(swipeDirection: SwipeDirection, numberOfTouches: int)

Parameters

Name	Type
swipeDirection	SwipeDirection
numberOfTouches	int

• Thread safety: unsafe

TouchTap(touchPositions: Array)

Parameters

Name	Type
touchPositions	Array

• Thread safety: unsafe

Removed members

Properties

• AbsoluteRotation
• SizeFromContents

External links

• GuiObject in the Roblox Creator Documentation
• GuiObject in the Roblox API Reference