GuiObject On DevHub

Summary

This class is not creatable. An object of this class cannot be created with Instance.new.

This item is not browsable. It is not visible in Studio's object browser.

Memory Category	Gui

Tags: [NotCreatable, NotBrowsable]

Inherits (3)

Inherited by (8)

Member index (50)

Type	Member	History
bool	Active
Vector2	AnchorPoint	271
AutomaticSize	AutomaticSize	449
BrickColor	BackgroundColor
Color3	BackgroundColor3
float	BackgroundTransparency
BrickColor	BorderColor
Color3	BorderColor3
BorderMode	BorderMode	397
int	BorderSizePixel
bool	ClipsDescendants	48
bool	Draggable	330
GuiState	GuiState	588
bool	Interactable	589
int	LayoutOrder	280
GuiObject	NextSelectionDown	197 206 206 329 524
GuiObject	NextSelectionLeft	197 206 206 329 524
GuiObject	NextSelectionRight	197 206 206 329 524
GuiObject	NextSelectionUp	197 206 206 329 524
UDim2	Position
float	Rotation	131
bool	Selectable	201 202 202 524
GuiObject	SelectionImageObject	200 329
int	SelectionOrder	524 527
UDim2	Size
SizeConstraint	SizeConstraint
float	Transparency
bool	Visible
int	ZIndex
bool	TweenPosition (UDim2 endPosition, EasingDirection easingDirection = Out, EasingStyle easingStyle = Quad, float time = 1, bool override = false, Function callback = nil)
bool	TweenSize (UDim2 endSize, EasingDirection easingDirection = Out, EasingStyle easingStyle = Quad, float time = 1, bool override = false, Function callback = nil)
bool	TweenSizeAndPosition (UDim2 endSize, UDim2 endPosition, EasingDirection easingDirection = Out, EasingStyle easingStyle = Quad, float time = 1, bool override = false, Function callback = nil)
	DragBegin (UDim2 initialPosition)	71 330
	DragStopped (int x, int y)	330
	InputBegan (InputObject input)	130 133 138 483
	InputChanged (InputObject input)	130 133 138 483
	InputEnded (InputObject input)	130 133 138 483
	MouseEnter (int x, int y)
	MouseLeave (int x, int y)
	MouseMoved (int x, int y)
	MouseWheelBackward (int x, int y)	69
	MouseWheelForward (int x, int y)	69
	SelectionGained ()	207
	SelectionLost ()	207
	TouchLongPress (Array touchPositions, UserInputState state)	130 131 138
	TouchPan (Array touchPositions, Vector2 totalTranslation, Vector2 velocity, UserInputState state)	130 131 138
	TouchPinch (Array touchPositions, float scale, float velocity, UserInputState state)	130 131 138
	TouchRotate (Array touchPositions, float rotation, float velocity, UserInputState state)	130 131 138
	TouchSwipe (SwipeDirection swipeDirection, int numberOfTouches)	130 138
	TouchTap (Array touchPositions)	130 131 133
16 members inherited from GuiBase2d
57 members inherited from Instance

Removed member index (2)

Type		Member	History
float		AbsoluteRotation	266 290 290 293
bool		SizeFromContents	293 339

589 Add GuiObject.Interactable
588 Add GuiObject.GuiState
527 Change Tags of GuiObject.SelectionOrder from [NotBrowsable] to []
524 Change Category of GuiObject.NextSelectionDown from Behavior to Selection
524 Change Category of GuiObject.NextSelectionLeft from Behavior to Selection
524 Change Category of GuiObject.NextSelectionRight from Behavior to Selection
524 Change Category of GuiObject.NextSelectionUp from Behavior to Selection
524 Change Category of GuiObject.Selectable from Data to Selection
524 Add GuiObject.SelectionOrder
483 Change Parameters of GuiObject.InputBegan from (Instance input) to (InputObject input)
483 Change Parameters of GuiObject.InputChanged from (Instance input) to (InputObject input)
483 Change Parameters of GuiObject.InputEnded from (Instance input) to (InputObject input)
449 Add GuiObject.AutomaticSize
397 Add GuiObject.BorderMode
339 Remove GuiObject.SizeFromContents
330 Change Tags of GuiObject.Draggable from [] to [Deprecated]
330 Change Tags of GuiObject.DragBegin from [] to [Deprecated]
330 Change Tags of GuiObject.DragStopped from [] to [Deprecated]
329 Change ValueType of GuiObject.NextSelectionDown from Object to GuiObject
329 Change ValueType of GuiObject.NextSelectionLeft from Object to GuiObject
329 Change ValueType of GuiObject.NextSelectionRight from Object to GuiObject
329 Change ValueType of GuiObject.NextSelectionUp from Object to GuiObject
329 Change ValueType of GuiObject.SelectionImageObject from Object to GuiObject
293 Remove GuiObject.AbsoluteRotation
293 Add GuiObject.SizeFromContents
290 Change ReadSecurity of GuiObject.AbsoluteRotation from RobloxSecurity to None
290 Change WriteSecurity of GuiObject.AbsoluteRotation from RobloxSecurity to None
280 Add GuiObject.LayoutOrder
271 Add GuiObject.AnchorPoint
266 Add GuiObject.AbsoluteRotation
207 Add GuiObject.SelectionGained
207 Add GuiObject.SelectionLost
206 Change ReadSecurity of GuiObject.NextSelectionDown from RobloxScriptSecurity to None
206 Change WriteSecurity of GuiObject.NextSelectionDown from RobloxScriptSecurity to None
206 Change ReadSecurity of GuiObject.NextSelectionLeft from RobloxScriptSecurity to None
206 Change WriteSecurity of GuiObject.NextSelectionLeft from RobloxScriptSecurity to None
206 Change ReadSecurity of GuiObject.NextSelectionRight from RobloxScriptSecurity to None
206 Change WriteSecurity of GuiObject.NextSelectionRight from RobloxScriptSecurity to None
206 Change ReadSecurity of GuiObject.NextSelectionUp from RobloxScriptSecurity to None
206 Change WriteSecurity of GuiObject.NextSelectionUp from RobloxScriptSecurity to None
202 Change ReadSecurity of GuiObject.Selectable from RobloxScriptSecurity to None
202 Change WriteSecurity of GuiObject.Selectable from RobloxScriptSecurity to None
201 Add GuiObject.Selectable
200 Add GuiObject.SelectionImageObject
197 Add GuiObject.NextSelectionDown
197 Add GuiObject.NextSelectionLeft
197 Add GuiObject.NextSelectionRight
197 Add GuiObject.NextSelectionUp
138 Change Security of GuiObject.InputBegan from RobloxScriptSecurity to None
138 Change Security of GuiObject.InputChanged from RobloxScriptSecurity to None
138 Change Security of GuiObject.InputEnded from RobloxScriptSecurity to None
138 Change Security of GuiObject.TouchLongPress from RobloxScriptSecurity to None
138 Change Security of GuiObject.TouchPan from RobloxScriptSecurity to None
138 Change Security of GuiObject.TouchPinch from RobloxScriptSecurity to None
138 Change Security of GuiObject.TouchRotate from RobloxScriptSecurity to None
138 Change Security of GuiObject.TouchSwipe from RobloxScriptSecurity to None
133 Change Parameters of GuiObject.InputBegan from (InputObject input) to (Instance input)
133 Change Parameters of GuiObject.InputChanged from (InputObject input) to (Instance input)
133 Change Parameters of GuiObject.InputEnded from (InputObject input) to (Instance input)
133 Change Security of GuiObject.TouchTap from RobloxScriptSecurity to None
131 Add GuiObject.Rotation
131 Change Parameters of GuiObject.TouchLongPress from (Vector2 position, UserInputState state) to (Array touchPositions, UserInputState state)
131 Change Parameters of GuiObject.TouchPan from (Vector2 position, Vector2 totalTranslation, Vector2 velocity, int numberOfTouches, UserInputState state) to (Array touchPositions, Vector2 totalTranslation, Vector2 velocity, UserInputState state)
131 Change Parameters of GuiObject.TouchPinch from (float scale, float velocity, UserInputState state) to (Array touchPositions, float scale, float velocity, UserInputState state)
131 Change Parameters of GuiObject.TouchRotate from (float rotation, float velocity, UserInputState state) to (Array touchPositions, float rotation, float velocity, UserInputState state)
131 Change Parameters of GuiObject.TouchTap from (Vector2 position) to (Array touchPositions)
130 Add GuiObject.InputBegan
130 Add GuiObject.InputChanged
130 Add GuiObject.InputEnded
130 Add GuiObject.TouchLongPress
130 Add GuiObject.TouchPan
130 Add GuiObject.TouchPinch
130 Add GuiObject.TouchRotate
130 Add GuiObject.TouchSwipe
130 Add GuiObject.TouchTap
85 Change Superclass of GuiObject from GuiBase to GuiBase2d
71 Change Parameters of GuiObject.DragBegin from (UDim2 InitialPosition) to (UDim2 initialPosition)
69 Add GuiObject.MouseWheelBackward
69 Add GuiObject.MouseWheelForward
48 Add GuiObject.ClipsDescendants

Members

Active On DevHub

Value Type	bool
Category	Data
Can Load	true
Can Save	true

AnchorPoint On DevHub

Value Type	Vector2
Category	Data
Can Load	true
Can Save	true

History

271 Add GuiObject.AnchorPoint

AutomaticSize On DevHub

Value Type	AutomaticSize
Category	Data
Can Load	true
Can Save	true

History

449 Add GuiObject.AutomaticSize

BackgroundColor On DevHub

This member is hidden. It is not meant to be used, and may have unresolved issues.

This item is deprecated. It exists for backwards-compatibility only, and should not be used for new work.

This item is not replicated. Its interface does not cross the network boundary.

Value Type	BrickColor
Category	Data
Can Load	true
Can Save	false

Tags: [Hidden, NotReplicated, Deprecated]

BackgroundColor3 On DevHub

Value Type	Color3
Category	Data
Can Load	true
Can Save	true

BackgroundTransparency On DevHub

Value Type	float
Category	Data
Can Load	true
Can Save	true
UIMaximum	1
UIMinimum	0

BorderColor On DevHub

This member is hidden. It is not meant to be used, and may have unresolved issues.

This item is deprecated. It exists for backwards-compatibility only, and should not be used for new work.

This item is not replicated. Its interface does not cross the network boundary.

Value Type	BrickColor
Category	Data
Can Load	true
Can Save	false

Tags: [Hidden, NotReplicated, Deprecated]

BorderColor3 On DevHub

Value Type	Color3
Category	Data
Can Load	true
Can Save	true

BorderMode On DevHub

Value Type	BorderMode
Category	Data
Can Load	true
Can Save	true

History

397 Add GuiObject.BorderMode

BorderSizePixel On DevHub

Value Type	int
Category	Data
Can Load	true
Can Save	true
UIMaximum	100
UIMinimum	0

ClipsDescendants On DevHub

Value Type	bool
Category	Behavior
Can Load	true
Can Save	true

History

48 Add GuiObject.ClipsDescendants

DragBegin On DevHub

This item is deprecated. It exists for backwards-compatibility only, and should not be used for new work.

Parameters	1

Name	Type	Default
initialPosition	UDim2	none

History

330 Change Tags of GuiObject.DragBegin from [] to [Deprecated]
71 Change Parameters of GuiObject.DragBegin from (UDim2 InitialPosition) to (UDim2 initialPosition)

Tags: [Deprecated]

DragStopped On DevHub

This item is deprecated. It exists for backwards-compatibility only, and should not be used for new work.

Parameters	2

Name	Type	Default
x	int	none
y	int	none

History

330 Change Tags of GuiObject.DragStopped from [] to [Deprecated]

Tags: [Deprecated]

Draggable On DevHub

This item is deprecated. It exists for backwards-compatibility only, and should not be used for new work.

Value Type	bool
Category	Behavior
Can Load	true
Can Save	true

History

330 Change Tags of GuiObject.Draggable from [] to [Deprecated]

Tags: [Deprecated]

GuiState On DevHub

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

This item is not replicated. Its interface does not cross the network boundary.

Value Type	GuiState
Category	State
Can Load	false
Can Save	true

History

588 Add GuiObject.GuiState

Tags: [ReadOnly, NotReplicated]

InputBegan On DevHub

Parameters	1

Name	Type	Default
input	InputObject	none

History

483 Change Parameters of GuiObject.InputBegan from (Instance input) to (InputObject input)
138 Change Security of GuiObject.InputBegan from RobloxScriptSecurity to None
133 Change Parameters of GuiObject.InputBegan from (InputObject input) to (Instance input)
130 Add GuiObject.InputBegan

InputChanged On DevHub

Parameters	1

Name	Type	Default
input	InputObject	none

History

483 Change Parameters of GuiObject.InputChanged from (Instance input) to (InputObject input)
138 Change Security of GuiObject.InputChanged from RobloxScriptSecurity to None
133 Change Parameters of GuiObject.InputChanged from (InputObject input) to (Instance input)
130 Add GuiObject.InputChanged

InputEnded On DevHub

Parameters	1

Name	Type	Default
input	InputObject	none

History

483 Change Parameters of GuiObject.InputEnded from (Instance input) to (InputObject input)
138 Change Security of GuiObject.InputEnded from RobloxScriptSecurity to None
133 Change Parameters of GuiObject.InputEnded from (InputObject input) to (Instance input)
130 Add GuiObject.InputEnded

Interactable On DevHub

Value Type	bool
Category	Data
Can Load	true
Can Save	true

History

589 Add GuiObject.Interactable

LayoutOrder On DevHub

Value Type	int
Category	Data
Can Load	true
Can Save	true

History

280 Add GuiObject.LayoutOrder

MouseEnter On DevHub

Parameters	2

Name	Type	Default
x	int	none
y	int	none

MouseLeave On DevHub

Parameters	2

Name	Type	Default
x	int	none
y	int	none

MouseMoved On DevHub

Parameters	2

Name	Type	Default
x	int	none
y	int	none

MouseWheelBackward On DevHub

Parameters	2

Name	Type	Default
x	int	none
y	int	none

History

69 Add GuiObject.MouseWheelBackward

MouseWheelForward On DevHub

Parameters	2

Name	Type	Default
x	int	none
y	int	none

History

69 Add GuiObject.MouseWheelForward

NextSelectionDown On DevHub

Value Type	GuiObject
Category	Selection
Can Load	true
Can Save	true

History

524 Change Category of GuiObject.NextSelectionDown from Behavior to Selection
329 Change ValueType of GuiObject.NextSelectionDown from Object to GuiObject
206 Change ReadSecurity of GuiObject.NextSelectionDown from RobloxScriptSecurity to None
206 Change WriteSecurity of GuiObject.NextSelectionDown from RobloxScriptSecurity to None
197 Add GuiObject.NextSelectionDown

NextSelectionLeft On DevHub

Value Type	GuiObject
Category	Selection
Can Load	true
Can Save	true

History

524 Change Category of GuiObject.NextSelectionLeft from Behavior to Selection
329 Change ValueType of GuiObject.NextSelectionLeft from Object to GuiObject
206 Change ReadSecurity of GuiObject.NextSelectionLeft from RobloxScriptSecurity to None
206 Change WriteSecurity of GuiObject.NextSelectionLeft from RobloxScriptSecurity to None
197 Add GuiObject.NextSelectionLeft

NextSelectionRight On DevHub

Value Type	GuiObject
Category	Selection
Can Load	true
Can Save	true

History

524 Change Category of GuiObject.NextSelectionRight from Behavior to Selection
329 Change ValueType of GuiObject.NextSelectionRight from Object to GuiObject
206 Change ReadSecurity of GuiObject.NextSelectionRight from RobloxScriptSecurity to None
206 Change WriteSecurity of GuiObject.NextSelectionRight from RobloxScriptSecurity to None
197 Add GuiObject.NextSelectionRight

NextSelectionUp On DevHub

Value Type	GuiObject
Category	Selection
Can Load	true
Can Save	true

History

524 Change Category of GuiObject.NextSelectionUp from Behavior to Selection
329 Change ValueType of GuiObject.NextSelectionUp from Object to GuiObject
206 Change ReadSecurity of GuiObject.NextSelectionUp from RobloxScriptSecurity to None
206 Change WriteSecurity of GuiObject.NextSelectionUp from RobloxScriptSecurity to None
197 Add GuiObject.NextSelectionUp

Position On DevHub

Value Type	UDim2
Category	Data
Can Load	true
Can Save	true

Rotation On DevHub

Value Type	float
Category	Data
Can Load	true
Can Save	true
UIMaximum	180
UIMinimum	-180
UINumTicks	360

History

131 Add GuiObject.Rotation

Selectable On DevHub

Value Type	bool
Category	Selection
Can Load	true
Can Save	true

History

524 Change Category of GuiObject.Selectable from Data to Selection
202 Change ReadSecurity of GuiObject.Selectable from RobloxScriptSecurity to None
202 Change WriteSecurity of GuiObject.Selectable from RobloxScriptSecurity to None
201 Add GuiObject.Selectable

SelectionGained On DevHub

Parameters	0

Name	Type	Default
No parameters.

History

207 Add GuiObject.SelectionGained

SelectionImageObject On DevHub

Value Type	GuiObject
Category	Appearance
Can Load	true
Can Save	true

History

329 Change ValueType of GuiObject.SelectionImageObject from Object to GuiObject
200 Add GuiObject.SelectionImageObject

SelectionLost On DevHub

Parameters	0

Name	Type	Default
No parameters.

History

207 Add GuiObject.SelectionLost

SelectionOrder On DevHub

Value Type	int
Category	Selection
Can Load	true
Can Save	true
FFlag	GamepadUISelectionOrder

History

527 Change Tags of GuiObject.SelectionOrder from [NotBrowsable] to []
524 Add GuiObject.SelectionOrder

Size On DevHub

Value Type	UDim2
Category	Data
Can Load	true
Can Save	true

SizeConstraint On DevHub

Value Type	SizeConstraint
Category	Data
Can Load	true
Can Save	true

TouchLongPress On DevHub

Parameters	2

Name	Type	Default
touchPositions	Array	none
state	UserInputState	none

History

138 Change Security of GuiObject.TouchLongPress from RobloxScriptSecurity to None
131 Change Parameters of GuiObject.TouchLongPress from (Vector2 position, UserInputState state) to (Array touchPositions, UserInputState state)
130 Add GuiObject.TouchLongPress

TouchPan On DevHub

Parameters	4

Name	Type	Default
touchPositions	Array	none
totalTranslation	Vector2	none
velocity	Vector2	none
state	UserInputState	none

History

138 Change Security of GuiObject.TouchPan from RobloxScriptSecurity to None
131 Change Parameters of GuiObject.TouchPan from (Vector2 position, Vector2 totalTranslation, Vector2 velocity, int numberOfTouches, UserInputState state) to (Array touchPositions, Vector2 totalTranslation, Vector2 velocity, UserInputState state)
130 Add GuiObject.TouchPan

TouchPinch On DevHub

Parameters	4

Name	Type	Default
touchPositions	Array	none
scale	float	none
velocity	float	none
state	UserInputState	none

History

138 Change Security of GuiObject.TouchPinch from RobloxScriptSecurity to None
131 Change Parameters of GuiObject.TouchPinch from (float scale, float velocity, UserInputState state) to (Array touchPositions, float scale, float velocity, UserInputState state)
130 Add GuiObject.TouchPinch

TouchRotate On DevHub

Parameters	4

Name	Type	Default
touchPositions	Array	none
rotation	float	none
velocity	float	none
state	UserInputState	none

History

138 Change Security of GuiObject.TouchRotate from RobloxScriptSecurity to None
131 Change Parameters of GuiObject.TouchRotate from (float rotation, float velocity, UserInputState state) to (Array touchPositions, float rotation, float velocity, UserInputState state)
130 Add GuiObject.TouchRotate

TouchSwipe On DevHub

Parameters	2

Name	Type	Default
swipeDirection	SwipeDirection	none
numberOfTouches	int	none

History

138 Change Security of GuiObject.TouchSwipe from RobloxScriptSecurity to None
130 Add GuiObject.TouchSwipe

TouchTap On DevHub

Parameters	1

Name	Type	Default
touchPositions	Array	none

History

133 Change Security of GuiObject.TouchTap from RobloxScriptSecurity to None
131 Change Parameters of GuiObject.TouchTap from (Vector2 position) to (Array touchPositions)
130 Add GuiObject.TouchTap

Transparency On DevHub

This member is hidden. It is not meant to be used, and may have unresolved issues.

This item is not replicated. Its interface does not cross the network boundary.

Value Type	float
Category	Data
Can Load	true
Can Save	false

Tags: [Hidden, NotReplicated]

TweenPosition On DevHub

Parameters	6

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

Return Type	bool

TweenSize On DevHub

Parameters	6

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

Return Type	bool

TweenSizeAndPosition On DevHub

Parameters	7

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

Return Type	bool

Visible On DevHub

Value Type	bool
Category	Data
Can Load	true
Can Save	true

ZIndex On DevHub

Value Type	int
Category	Data
Can Load	true
Can Save	true

Removed members

AbsoluteRotation

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

Value Type	float
Category
Can Load	false
Can Save	false

History

293 Remove GuiObject.AbsoluteRotation
290 Change ReadSecurity of GuiObject.AbsoluteRotation from RobloxSecurity to None
290 Change WriteSecurity of GuiObject.AbsoluteRotation from RobloxSecurity to None
266 Add GuiObject.AbsoluteRotation

Tags: [ReadOnly]

SizeFromContents

Value Type	bool
Category
Can Load	false
Can Save	false