GuiButton
CreatorHub

An abstract class for interactive 2D user interface elements.

Instances of this class cannot be created with Instance.new.

It is not visible in Studio's object browser.

Memory category	Gui

Tags: [NotCreatable, NotBrowsable]

Member index 14

History		Member
726		AutoButtonColor: bool
726		HoverHapticEffect: HapticEffect
726		Modal: bool
726		PressHapticEffect: HapticEffect
726		Selected: bool
726		Style: ButtonStyle
483		Activated(inputObject: InputObject, clickCount: int)
462		MouseButton1Click()
462		MouseButton1Down(x: int, y: int)
462		MouseButton1Up(x: int, y: int)
462		MouseButton2Click()
462		MouseButton2Down(x: int, y: int)
462		MouseButton2Up(x: int, y: int)
687		SecondaryActivated(inputObject: InputObject)
55 members inherited from GuiObject
726		Active: bool
726		AnchorPoint: Vector2
726		AutomaticSize: AutomaticSize
726		BackgroundColor: BrickColor
726		BackgroundColor3: Color3
726		BackgroundTransparency: float
726		BorderColor: BrickColor
726		BorderColor3: Color3
726		BorderMode: BorderMode
726		BorderSizePixel: int
726		ClipsDescendants: bool
726		Draggable: bool
726		GuiState: GuiState
726		InputSink: InputSink
726		Interactable: bool
726		LayoutOrder: int
726		NextSelectionDown: GuiObject
726		NextSelectionLeft: GuiObject
726		NextSelectionRight: GuiObject
726		NextSelectionUp: GuiObject
726		Position: UDim2
726		Rotation: float
726		Selectable: bool
726		SelectionImageObject: GuiObject
726		SelectionOrder: int
726		SelectionRect2D: Rect
726		Size: UDim2
726		SizeConstraint: SizeConstraint
726		Transparency: float
726		Visible: bool
726		ZIndex: int
462		TweenPosition(endPosition: UDim2, easingDirection: EasingDirection = Out, easingStyle: EasingStyle = Quad, time: float = 1, override: bool = false, callback: Function = nil): bool
713		TweenPositionInternal(endPosition: UDim2, easingDirection: EasingDirection = Out, easingStyle: EasingStyle = Quad, time: float = 1, override: bool = false, callback: Function = nil): bool
462		TweenSize(endSize: UDim2, easingDirection: EasingDirection = Out, easingStyle: EasingStyle = Quad, time: float = 1, override: bool = false, callback: Function = nil): bool
462		TweenSizeAndPosition(endSize: UDim2, endPosition: UDim2, easingDirection: EasingDirection = Out, easingStyle: EasingStyle = Quad, time: float = 1, override: bool = false, callback: Function = nil): bool
713		TweenSizeAndPositionInternal(endSize: UDim2, endPosition: UDim2, easingDirection: EasingDirection = Out, easingStyle: EasingStyle = Quad, time: float = 1, override: bool = false, callback: Function = nil): bool
713		TweenSizeInternal(endSize: UDim2, easingDirection: EasingDirection = Out, easingStyle: EasingStyle = Quad, time: float = 1, override: bool = false, callback: Function = nil): bool
462		DragBegin(initialPosition: UDim2)
462		DragStopped(x: int, y: int)
483		InputBegan(input: InputObject)
483		InputChanged(input: InputObject)
483		InputEnded(input: InputObject)
462		MouseEnter(x: int, y: int)
462		MouseLeave(x: int, y: int)
462		MouseMoved(x: int, y: int)
462		MouseWheelBackward(x: int, y: int)
462		MouseWheelForward(x: int, y: int)
462		SelectionGained()
462		SelectionLost()
462		TouchLongPress(touchPositions: Array, state: UserInputState)
462		TouchPan(touchPositions: Array, totalTranslation: Vector2, velocity: Vector2, state: UserInputState)
462		TouchPinch(touchPositions: Array, scale: float, velocity: float, state: UserInputState)
462		TouchRotate(touchPositions: Array, rotation: float, velocity: float, state: UserInputState)
462		TouchSwipe(swipeDirection: SwipeDirection, numberOfTouches: int)
462		TouchTap(touchPositions: Array)
16 members inherited from GuiBase2d
726		AbsolutePosition: Vector2
726		AbsoluteRotation: float
726		AbsoluteSize: Vector2
726		AutoLocalize: bool
726		ClippedRect: Rect
726		IsNotOccluded: bool
726		Localize: bool
726		RawRect2D: Rect
726		RootLocalizationTable: LocalizationTable
726		SelectionBehaviorDown: SelectionBehavior
726		SelectionBehaviorLeft: SelectionBehavior
726		SelectionBehaviorRight: SelectionBehavior
726		SelectionBehaviorUp: SelectionBehavior
726		SelectionGroup: bool
726		TotalGroupScale: float
525		SelectionChanged(amISelected: bool, previousSelection: GuiObject, newSelection: GuiObject)
60 members inherited from Instance
726		Archivable: bool
726		Capabilities: SecurityCapabilities
726		DataCost: int
726		IsInSandbox: bool
726		Name: string
726		Parent: Instance
726		PredictionMode: PredictionMode
726		RobloxLocked: bool
726		Sandboxed: bool
726		SourceAssetId: int64
726		UniqueId: UniqueId
726		archivable: bool
576		AddTag(tag: string): null
573		ClearAllChildren(): null
462		Clone(): Instance
573		Destroy(): null
486		FindFirstAncestor(name: string): Instance
486		FindFirstAncestorOfClass(className: string): Instance
486		FindFirstAncestorWhichIsA(className: string): Instance
486		FindFirstChild(name: string, recursive: bool = false): Instance
486		FindFirstChildOfClass(className: string): Instance
486		FindFirstChildWhichIsA(className: string, recursive: bool = false): Instance
486		FindFirstDescendant(name: string): Instance
563		GetActor(): Actor
486		GetAttribute(attribute: string): Variant
462		GetAttributeChangedSignal(attribute: string): RBXScriptSignal
631		GetAttributes(): Dictionary
648		GetChildren(): Instances
462		GetDebugId(scopeLength: int = 4): string
707		GetDescendants(): Instances
486		GetFullName(): string
706		GetStyled(name: string, selector: string?): Variant
657		GetStyledPropertyChangedSignal(property: string): RBXScriptSignal
576		GetTags(): Array
576		HasTag(tag: string): bool
486		IsAncestorOf(descendant: Instance): bool
486		IsDescendantOf(ancestor: Instance): bool
664		IsPropertyModified(property: string): bool
698		QueryDescendants(selector: string): Instances
573		Remove(): null
576		RemoveTag(tag: string): null
664		ResetPropertyToDefault(property: string): null
573		SetAttribute(attribute: string, value: Variant): null
462		WaitForChild(childName: string, timeOut: double): Instance
726		children(): Instances
726		clone(): Instance
726		destroy(): null
726		findFirstChild(name: string, recursive: bool = false): Instance
726		getChildren(): Instances
726		isDescendantOf(ancestor: Instance): bool
726		remove(): null
462		AncestryChanged(child: Instance, parent: Instance)
462		AttributeChanged(attribute: string)
462		ChildAdded(child: Instance)
462		ChildRemoved(child: Instance)
462		DescendantAdded(descendant: Instance)
462		DescendantRemoving(descendant: Instance)
500		Destroying()
657		StyledPropertiesChanged()
726		childAdded(child: Instance)
6 members inherited from Object
726		ClassName: string
726		className: string
647		GetPropertyChangedSignal(property: string): RBXScriptSignal
647		IsA(className: string): bool
726		isA(className: string): bool
647		Changed(property: string)

Removed member index 7

History		Member
726		MouseButton1ClickConnectionCount: int
726		MouseButton1DownConnectionCount: int
726		MouseButton1UpConnectionCount: int
726		MouseButton2ClickConnectionCount: int
726		MouseButton2DownConnectionCount: int
726		MouseButton2UpConnectionCount: int
402		SetVerb(verb: string): void

Description

GuiButton is an abstract class that inherits from GuiObject. It is the base class for the interactive, clickable ImageButton and TextButton objects. This class also defines several properties for interactive behavior, namely AutoButtonColor and Modal.

The most important event of a GuiButton is Activated, a multi-platform event that fires when the button is activated. When using a mouse, this means clicking the button and releasing with the cursor still over the UI object. For touch, the same applies but with a touch instead of button press. Finally, for gamepads, Activated fires if a GuiButton is selected when the A button is pressed and released. In short, this event is very useful for multi-platform user interface programming as it provides a nice general interface for a single user input.

History 58
Hide member changes

726 Change Default of Style from to
726 Change Default of Selected from to
726 Change Default of PressHapticEffect from to
726 Remove MouseButton2UpConnectionCount
726 Remove MouseButton2DownConnectionCount
726 Remove MouseButton2ClickConnectionCount
726 Remove MouseButton1UpConnectionCount
726 Remove MouseButton1DownConnectionCount
726 Remove MouseButton1ClickConnectionCount
726 Change Default of Modal from to
726 Change Default of HoverHapticEffect from to
726 Change Default of AutoButtonColor from to
687 Add SecondaryActivated
665 Add PressHapticEffect
665 Add HoverHapticEffect
578 Change Category of Selected from Data to Selection
553 Change Default of Style from to
553 Change Default of Selected from to
553 Add MouseButton2UpConnectionCount
553 Add MouseButton2DownConnectionCount
553 Add MouseButton2ClickConnectionCount
553 Add MouseButton1UpConnectionCount
553 Add MouseButton1DownConnectionCount
553 Add MouseButton1ClickConnectionCount
553 Change Default of Modal from to
553 Change Default of AutoButtonColor from to
486 Change ThreadSafety of Style from ReadOnly to ReadSafe
486 Change ThreadSafety of Selected from ReadOnly to ReadSafe
486 Change ThreadSafety of Modal from ReadOnly to ReadSafe
486 Change ThreadSafety of AutoButtonColor from ReadOnly to ReadSafe
483 Change Parameters of Activated from (inputObject: Instance, clickCount: int) to (inputObject: InputObject, clickCount: int)
462 Change ThreadSafety of MouseButton2Up from to Unsafe
462 Change ThreadSafety of MouseButton2Down from to Unsafe
462 Change ThreadSafety of MouseButton2Click from to Unsafe
462 Change ThreadSafety of MouseButton1Up from to Unsafe
462 Change ThreadSafety of MouseButton1Down from to Unsafe
462 Change ThreadSafety of MouseButton1Click from to Unsafe
462 Change ThreadSafety of Activated from to Unsafe
462 Change ThreadSafety of Style from to ReadOnly
462 Change ThreadSafety of Selected from to ReadOnly
462 Change ThreadSafety of Modal from to ReadOnly
462 Change ThreadSafety of AutoButtonColor from to ReadOnly
423 Change Parameters of Activated from (inputObject: Instance) to (inputObject: Instance, clickCount: int)
402 Remove SetVerb
304 Add Activated
55 Change Tags of GuiButton from [NotCreatable] to [NotCreatable, NotBrowsable]
47 Add MouseButton2Up
47 Add MouseButton2Down
47 Add MouseButton2Click
47 Add MouseButton1Up
47 Add MouseButton1Down
47 Add MouseButton1Click
47 Add SetVerb
47 Add Style
47 Add Selected
47 Add Modal
47 Add AutoButtonColor
47 Add GuiButton

Members 14

Activated
CreatorHub

Parameters (2)
inputObject	InputObject
clickCount	int

Fires when a left click press-and-release is detected on desktop, touch release is detected on mobile, or A/cross is activated in UI navigation mode on console.

As this event doesn't fire on the server, it should only be used in a LocalScript, or in a Script with RunContext of RunContext.Client.

Thread safety	Unsafe

History 4

483 Change Parameters of Activated from (inputObject: Instance, clickCount: int) to (inputObject: InputObject, clickCount: int)
462 Change ThreadSafety of Activated from to Unsafe
423 Change Parameters of Activated from (inputObject: Instance) to (inputObject: Instance, clickCount: int)
304 Add Activated

AutoButtonColor
CreatorHub

Type		Default
bool

This property determines whether the button automatically changes color when the user's Mouse hovers over or clicks on it. If true, the button will automatically change color when the mouse hovers over or clicks on it. If false, the button will not change.

If you would like to customize how a button changes when the user's mouse hovers over or clicks on it, consider using an ImageButton and changing the element's HoverImage and PressedImage.

Please note that this property will not have an effect on an ImageButton if its Image property is set to an image. Additionally, this property will not affect an ImageButton on mouse hover when its HoverImage is not nil, nor on mouse click if its PressedImage is not nil.

Thread safety	ReadSafe
Category	Data
Loaded/Saved	true

History 5

726 Change Default of AutoButtonColor from to
553 Change Default of AutoButtonColor from to
486 Change ThreadSafety of AutoButtonColor from ReadOnly to ReadSafe
462 Change ThreadSafety of AutoButtonColor from to ReadOnly
47 Add AutoButtonColor

HoverHapticEffect
CreatorHub

Type		Default
HapticEffect

A HapticEffect instance that will play when the GuiButton is being hovered.

Thread safety	ReadSafe
Category	Haptic
Loaded/Saved	true

History 2

726 Change Default of HoverHapticEffect from to
665 Add HoverHapticEffect

Modal
CreatorHub

Type		Default
bool

If true while the GUI element is visible, the mouse will not be locked unless the right mouse button is down.

Thread safety	ReadSafe
Category	Data
Loaded/Saved	true

History 5

726 Change Default of Modal from to
553 Change Default of Modal from to
486 Change ThreadSafety of Modal from ReadOnly to ReadSafe
462 Change ThreadSafety of Modal from to ReadOnly
47 Add Modal

MouseButton1Click
CreatorHub

Parameters (0)
No parameters.

This event fires when the user's mouse fully left clicks the GuiButton.

In regards to clicking, the mouse must be in bounds of the GuiButton and the mouse button must be pressed down and up again before this event fires. If the mouse leaves the bounds of the GuiButton and is released, the event will not fire. If you would like to avoid this limitation, you can use MouseButton1Down and MouseButton1Up; these events are similar but will fire whenever the user presses their left mouse button down or up, respectively.

Thread safety	Unsafe

History 2

462 Change ThreadSafety of MouseButton1Click from to Unsafe
47 Add MouseButton1Click

MouseButton1Down
CreatorHub

Parameters (2)
x	int
y	int

This event fires when the user presses their left mouse button down on the GuiButton.

For an event requiring the user to press and release their left mouse on a GuiButton in order for the event to fire, consider using MouseButton1Click.

Thread safety	Unsafe

History 2

462 Change ThreadSafety of MouseButton1Down from to Unsafe
47 Add MouseButton1Down

MouseButton1Up
CreatorHub

Parameters (2)
x	int
y	int

This event fires when the user releases their left mouse button off of the GuiButton.

For an event requiring the user to press and release their left mouse on a GuiButton in order for the event to fire, consider using MouseButton1Click.

Thread safety	Unsafe

History 2

462 Change ThreadSafety of MouseButton1Up from to Unsafe
47 Add MouseButton1Up

MouseButton2Click
CreatorHub

Parameters (0)
No parameters.

This event fires when the user's mouse fully right clicks the GuiButton.

In regards to clicking, the mouse must be in bounds of the GuiButton and the mouse button must be pressed down and up again before this event fires. If the mouse leaves the bounds of the GuiButton and is released, the event will not fire. If you would like to avoid this limitation, you can use MouseButton2Down and MouseButton2Up; these events are similar but will fire whenever the user presses their right mouse button down or up, respectively.

Thread safety	Unsafe

History 2

462 Change ThreadSafety of MouseButton2Click from to Unsafe
47 Add MouseButton2Click

MouseButton2Down
CreatorHub

Parameters (2)
x	int
y	int

This event fires when the user presses their right mouse button down on the GuiButton.

For an event requiring the user to press and release their right mouse on a GuiButton in order for the event to fire, consider using MouseButton2Click.

Thread safety	Unsafe

History 2

462 Change ThreadSafety of MouseButton2Down from to Unsafe
47 Add MouseButton2Down

MouseButton2Up
CreatorHub

Parameters (2)
x	int
y	int

This event fires when the user releases their right mouse button off of the GuiButton.

For an event requiring the user to press and release their right mouse on a GuiButton in order for the event to fire, consider using MouseButton2Click.

Thread safety	Unsafe

History 2

462 Change ThreadSafety of MouseButton2Up from to Unsafe
47 Add MouseButton2Up

PressHapticEffect
CreatorHub

Type		Default
HapticEffect

A HapticEffect instance that will play when the GuiButton is being pressed.

Thread safety	ReadSafe
Category	Haptic
Loaded/Saved	true

History 2

726 Change Default of PressHapticEffect from to
665 Add PressHapticEffect

SecondaryActivated
CreatorHub

Parameters (1)
inputObject	InputObject

Fires when a right-click press-and-release is detected from a mouse, long press is detected on a touch input, R3 is detected from a gamepad, or AltEnter is detected in UI navigation mode using keyboard.

Thread safety	Unsafe

History 1

687 Add SecondaryActivated

Selected
CreatorHub

Type		Default
bool

A boolean property which indicates whether the object has been selected.

Thread safety	ReadSafe
Category	Selection
Loaded/Saved	true

History 6

726 Change Default of Selected from to
578 Change Category of Selected from Data to Selection
553 Change Default of Selected from to
486 Change ThreadSafety of Selected from ReadOnly to ReadSafe
462 Change ThreadSafety of Selected from to ReadOnly
47 Add Selected

Style
CreatorHub

Type		Default
ButtonStyle

Sets the style of the GuiButton based on a list of pre-determined styles.

Thread safety	ReadSafe
Category	Data
Loaded/Saved	true

History 5

726 Change Default of Style from to
553 Change Default of Style from to
486 Change ThreadSafety of Style from ReadOnly to ReadSafe
462 Change ThreadSafety of Style from to ReadOnly
47 Add Style

Removed members 7

MouseButton1ClickConnectionCount
CreatorHub

Type		Default
int

It cannot be accessed by script code.

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

Thread safety	ReadSafe
Category	EventReplicator
Loaded/Saved	false

History 2

726 Remove MouseButton1ClickConnectionCount
553 Add MouseButton1ClickConnectionCount

Tags: [Hidden, NotScriptable]

MouseButton1DownConnectionCount
CreatorHub

Type		Default
int

It cannot be accessed by script code.

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

Thread safety	ReadSafe
Category	EventReplicator
Loaded/Saved	false

History 2

726 Remove MouseButton1DownConnectionCount
553 Add MouseButton1DownConnectionCount

Tags: [Hidden, NotScriptable]

MouseButton1UpConnectionCount
CreatorHub

Type		Default
int

It cannot be accessed by script code.

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

Thread safety	ReadSafe
Category	EventReplicator
Loaded/Saved	false

History 2

726 Remove MouseButton1UpConnectionCount
553 Add MouseButton1UpConnectionCount

Tags: [Hidden, NotScriptable]

MouseButton2ClickConnectionCount
CreatorHub

Type		Default
int

It cannot be accessed by script code.

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

Thread safety	ReadSafe
Category	EventReplicator
Loaded/Saved	false

History 2

726 Remove MouseButton2ClickConnectionCount
553 Add MouseButton2ClickConnectionCount

Tags: [Hidden, NotScriptable]

MouseButton2DownConnectionCount
CreatorHub

Type		Default
int

It cannot be accessed by script code.

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

Thread safety	ReadSafe
Category	EventReplicator
Loaded/Saved	false

History 2

726 Remove MouseButton2DownConnectionCount
553 Add MouseButton2DownConnectionCount

Tags: [Hidden, NotScriptable]

MouseButton2UpConnectionCount
CreatorHub

Type		Default
int

It cannot be accessed by script code.

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

Thread safety	ReadSafe
Category	EventReplicator
Loaded/Saved	false

History 2

726 Remove MouseButton2UpConnectionCount
553 Add MouseButton2UpConnectionCount

Tags: [Hidden, NotScriptable]

SetVerb
CreatorHub

Parameters (1)
verb	string
Returns (1)
void

Security	RobloxScriptSecurity

History 2

402 Remove SetVerb
47 Add SetVerb

Engine API

Website

Related

History 4

History 5

History 2

History 5

History 2

History 2

History 2

History 2

History 2

History 2

History 2

History 1

History 6

History 5

History 2

History 2

History 2

History 2

History 2

History 2

History 2