Reference API Roblox

Engine API

Website

Related

Reference API Roblox

GuiObject

Summary

This class is not creatable. Instances of this class cannot be created with Instance.new.
This class is not browsable. It is not visible in Studio's object browser.
Tags: [NotCreatable, NotBrowsable]

Member index 57

HistoryMember
553Active: bool
553AnchorPoint: Vector2
553AutomaticSize: AutomaticSize
553BackgroundColor3: Color3
553BackgroundTransparency: float
553BorderColor3: Color3
553BorderMode: BorderMode
553BorderSizePixel: int
553ClipsDescendants: bool
553Draggable: bool
588GuiState: GuiState
589Interactable: bool
553LayoutOrder: int
553NextSelectionDown: GuiObject
553NextSelectionLeft: GuiObject
553NextSelectionRight: GuiObject
553NextSelectionUp: GuiObject
553Position: UDim2
553Rotation: float
553Selectable: bool
553SelectionImageObject: GuiObject
553SelectionOrder: int
553Size: UDim2
553SizeConstraint: SizeConstraint
553Visible: bool
553ZIndex: int
462TweenPosition(endPosition: UDim2, easingDirection: EasingDirection = Out, easingStyle: EasingStyle = Quad, time: float = 1, override: bool = false, callback: Function = nil): bool
462TweenSize(endSize: UDim2, easingDirection: EasingDirection = Out, easingStyle: EasingStyle = Quad, time: float = 1, override: bool = false, callback: Function = nil): bool
462TweenSizeAndPosition(endSize: UDim2, endPosition: UDim2, easingDirection: EasingDirection = Out, easingStyle: EasingStyle = Quad, time: float = 1, override: bool = false, callback: Function = nil): bool
462DragBegin(initialPosition: UDim2)
462DragStopped(x: int, y: int)
483InputBegan(input: InputObject)
483InputChanged(input: InputObject)
483InputEnded(input: InputObject)
462MouseEnter(x: int, y: int)
462MouseLeave(x: int, y: int)
462MouseMoved(x: int, y: int)
462MouseWheelBackward(x: int, y: int)
462MouseWheelForward(x: int, y: int)
462SelectionGained()
462SelectionLost()
462TouchLongPress(touchPositions: Array, state: UserInputState)
462TouchPan(touchPositions: Array, totalTranslation: Vector2, velocity: Vector2, state: UserInputState)
462TouchPinch(touchPositions: Array, scale: float, velocity: float, state: UserInputState)
462TouchRotate(touchPositions: Array, rotation: float, velocity: float, state: UserInputState)
462TouchSwipe(swipeDirection: SwipeDirection, numberOfTouches: int)
462TouchTap(touchPositions: Array)
inherited from GuiBase2d
553AbsolutePosition: Vector2
553AbsoluteRotation: float
553AbsoluteSize: Vector2
553AutoLocalize: bool
553RootLocalizationTable: LocalizationTable
553SelectionBehaviorDown: SelectionBehavior
553SelectionBehaviorLeft: SelectionBehavior
553SelectionBehaviorRight: SelectionBehavior
553SelectionBehaviorUp: SelectionBehavior
553SelectionGroup: bool
525SelectionChanged(amISelected: bool, previousSelection: GuiObject, newSelection: GuiObject)
inherited from Instance
553Archivable: bool
619Capabilities: SecurityCapabilities
553ClassName: string
553Name: string
553Parent: Instance
619Sandboxed: bool
616UniqueId: UniqueId
553className: string
576AddTag(tag: string): null
573ClearAllChildren(): null
462Clone(): Instance
573Destroy(): null
486FindFirstAncestor(name: string): Instance
486FindFirstAncestorOfClass(className: string): Instance
486FindFirstAncestorWhichIsA(className: string): Instance
486FindFirstChild(name: string, recursive: bool = false): Instance
486FindFirstChildOfClass(className: string): Instance
486FindFirstChildWhichIsA(className: string, recursive: bool = false): Instance
486FindFirstDescendant(name: string): Instance
563GetActor(): Actor
486GetAttribute(attribute: string): Variant
462GetAttributeChangedSignal(attribute: string): RBXScriptSignal
486GetAttributes(): Dictionary
486GetChildren(): Objects
462GetDebugId(scopeLength: int = 4): string
486GetDescendants(): Array
486GetFullName(): string
462GetPropertyChangedSignal(property: string): RBXScriptSignal
576GetTags(): Array
576HasTag(tag: string): bool
486IsA(className: string): bool
486IsAncestorOf(descendant: Instance): bool
486IsDescendantOf(ancestor: Instance): bool
580IsPropertyModified(name: string): bool
573Remove(): null
576RemoveTag(tag: string): null
580ResetPropertyToDefault(name: string): null
573SetAttribute(attribute: string, value: Variant): null
462WaitForChild(childName: string, timeOut: double): Instance
553children(): Objects
553clone(): Instance
573destroy(): null
553findFirstChild(name: string, recursive: bool = false): Instance
553getChildren(): Objects
462isA(className: string): bool
553isDescendantOf(ancestor: Instance): bool
573remove(): null
462AncestryChanged(child: Instance, parent: Instance)
462AttributeChanged(attribute: string)
462Changed(property: string)
462ChildAdded(child: Instance)
462ChildRemoved(child: Instance)
462DescendantAdded(descendant: Instance)
462DescendantRemoving(descendant: Instance)
500Destroying()
553childAdded(child: Instance)

Removed member index 2

HistoryMember
293AbsoluteRotation: float
339SizeFromContents: bool

History 210

Members 57

Active

TypeDefault
bool

History 4

AnchorPoint

TypeDefault
Vector2

History 4

AutomaticSize

TypeDefault
AutomaticSize

History 4

BackgroundColor3

TypeDefault
Color3

History 4

BackgroundTransparency

TypeDefault
float

History 4

BorderColor3

TypeDefault
Color3

History 4

BorderMode

TypeDefault
BorderMode

History 4

BorderSizePixel

TypeDefault
int

History 4

ClipsDescendants

TypeDefault
bool

History 4

DragBegin

Parameters (1)
initialPositionUDim2
This event is deprecated. It exists only for backward compatibility, and should not be used for new work.

History 4

Tags: [Deprecated]

DragStopped

Parameters (2)
xint
yint
This event is deprecated. It exists only for backward compatibility, and should not be used for new work.

History 3

Tags: [Deprecated]

Draggable

TypeDefault
bool
This property is deprecated. It exists only for backward compatibility, and should not be used for new work.

History 5

Tags: [Deprecated]

GuiState

TypeDefault
GuiState
This property is not replicated. Its interface does not cross the network boundary.
This property is read-only. Its value can be read, but it cannot be modified.

History 1

Tags: [ReadOnly, NotReplicated]

InputBegan

Parameters (1)
inputInputObject

History 5

InputChanged

Parameters (1)
inputInputObject

History 5

InputEnded

Parameters (1)
inputInputObject

History 5

Interactable

TypeDefault
bool

History 1

LayoutOrder

TypeDefault
int

History 4

MouseEnter

Parameters (2)
xint
yint

History 2

MouseLeave

Parameters (2)
xint
yint

History 2

MouseMoved

Parameters (2)
xint
yint

History 2

MouseWheelBackward

Parameters (2)
xint
yint

History 2

MouseWheelForward

Parameters (2)
xint
yint

History 2

NextSelectionDown

TypeDefault
GuiObject

History 8

NextSelectionLeft

TypeDefault
GuiObject

History 8

NextSelectionRight

TypeDefault
GuiObject

History 8

NextSelectionUp

TypeDefault
GuiObject

History 8

Position

TypeDefault
UDim2

History 4

Rotation

TypeDefault
float

History 4

Selectable

TypeDefault
bool

History 7

SelectionGained

Parameters (0)
No parameters.

History 2

SelectionImageObject

TypeDefault
GuiObject

History 5

SelectionLost

Parameters (0)
No parameters.

History 2

SelectionOrder

TypeDefault
int

History 3

Size

TypeDefault
UDim2

History 4

  • 553 Change Default of Size from to
  • 486 Change ThreadSafety of Size from ReadOnly to ReadSafe
  • 462 Change ThreadSafety of Size from to ReadOnly
  • 47 Add Size

SizeConstraint

TypeDefault
SizeConstraint

History 4

TouchLongPress

Parameters (2)
touchPositionsArray
stateUserInputState

History 4

TouchPan

Parameters (4)
touchPositionsArray
totalTranslationVector2
velocityVector2
stateUserInputState

History 4

TouchPinch

Parameters (4)
touchPositionsArray
scalefloat
velocityfloat
stateUserInputState

History 4

TouchRotate

Parameters (4)
touchPositionsArray
rotationfloat
velocityfloat
stateUserInputState

History 4

TouchSwipe

Parameters (2)
swipeDirectionSwipeDirection
numberOfTouchesint

History 3

TouchTap

Parameters (1)
touchPositionsArray

History 4

TweenPosition

Parameters (6)Default
endPositionUDim2
easingDirectionEasingDirectionOut
easingStyleEasingStyleQuad
timefloat1
overrideboolfalse
callbackFunctionnil
Returns (1)
bool

History 2

TweenSize

Parameters (6)Default
endSizeUDim2
easingDirectionEasingDirectionOut
easingStyleEasingStyleQuad
timefloat1
overrideboolfalse
callbackFunctionnil
Returns (1)
bool

History 2

TweenSizeAndPosition

Parameters (7)Default
endSizeUDim2
endPositionUDim2
easingDirectionEasingDirectionOut
easingStyleEasingStyleQuad
timefloat1
overrideboolfalse
callbackFunctionnil
Returns (1)
bool

History 2

Visible

TypeDefault
bool

History 4

ZIndex

TypeDefault
int

History 4

Removed members 2

AbsoluteRotation

TypeDefault
float
This property is read-only. Its value can be read, but it cannot be modified.

History 4

Tags: [ReadOnly]

SizeFromContents

TypeDefault
bool

History 2

Settings