GuiButton
An abstract class for interactive 2D user interface elements.
| Memory category | Gui |
|---|
Member index 20
Removed member index 1
| History | Member | |
|---|---|---|
| 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 46
- 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
- 553 Add
- 553 Add
- 553 Add
- 553 Add
- 553 Add
- 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 20
Activated
| 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. The first time this method is called,
clickCount will start at 0.
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
| 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 4
- 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
| Type | Default | |
|---|---|---|
| HapticEffect | ||
A HapticEffect that the engine plays the first time the pointer moves over the button, when the button transitions from its idle state to its hover state. Assign a HapticEffect to give hover feedback (for example, a light effect on gamepad or mobile); leave it unset for no hover haptics.
The effect plays through the standard HapticService mixer, so
whether the player actually feels vibration depends on their device and
haptic settings. This property defaults to nil (no effect).
| Thread safety | ReadSafe |
|---|---|
| Category | Haptic |
| Loaded/Saved | true |
History 1
- 665 Add HoverHapticEffect
Modal
| 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 |
MouseButton1Click
| 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
| 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
| 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
| 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
| 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
| 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
| Type | Default | |
|---|---|---|
| HapticEffect | ||
A HapticEffect that the engine plays when the button enters its pressed state. Assign a HapticEffect to give press or click feedback; leave it unset for no press haptics.
The effect plays through the standard HapticService mixer, so
whether the player actually feels vibration depends on their device and
haptic settings. This property defaults to nil (no effect).
| Thread safety | ReadSafe |
|---|---|
| Category | Haptic |
| Loaded/Saved | true |
History 1
- 665 Add PressHapticEffect
SecondaryActivated
| 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
Selected
| Type | Default | |
|---|---|---|
| bool | ||
When set to true, the button renders in a highlighted "selected" state
instead of its normal idle appearance. This property defaults to false,
and the engine never changes it automatically; set it yourself to mark a
button as selected.
Selected only has a visual effect on the legacy ButtonStyle
presets (the Roblox* styles) with
AutoButtonColor enabled, where it swaps
in the button's highlighted image. It has no effect under the default
Style of Custom. It is unrelated to gamepad and
controller UI navigation; the currently focused element is tracked
separately by SelectedObject.
| Thread safety | ReadSafe |
|---|---|
| Category | Selection |
| Loaded/Saved | true |
Style
| Type | Default | |
|---|---|---|
| ButtonStyle | ||
Sets the button's overall appearance from a fixed set of
ButtonStyle presets. The default value is Custom, which applies
no built-in styling and lets you control the button's appearance entirely
through properties such as
BackgroundColor3 and, for an
ImageButton, its images.
A legacy method of applying a fixed set of Roblox-themed button styles.
The remaining presets (RobloxButton, RobloxButtonDefault,
RobloxRoundButton, RobloxRoundDefaultButton, and
RobloxRoundDropdownButton) render Roblox-themed button art. New
interfaces should keep Custom and style the button directly. This
property defaults to ButtonStyle.Custom.
| Thread safety | ReadSafe |
|---|---|
| Category | Data |
| Loaded/Saved | true |