GuiButton

Mostrar obsoleto
no creable
no explorable

GuiButton is an abstract class that inherits from GuiObject. It is the base class for ImageButton and TextButton. Objects of this type serve to be interactive, clickable user interface elements. It defines several properties for interaction behavior, namely GuiButton.AutoButtonColor and GuiButton.Modal, as well as a handful of events for mouse buttons (GuiButton.MouseButton1Click, GuiButton.MouseButton1Down, etc).

The most important event of a GuiButton is GuiButton.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, GuiButton.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.

Resumen

Propiedades

  • AutoButtonColor:bool
    leer paralelo

    Determines whether the button automatically changes color when the mouse hovers over or clicks on it.

  • Modal:bool
    leer paralelo

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

  • Selected:bool
    leer paralelo

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

  • Style:Enum.ButtonStyle
    leer paralelo

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

Propiedades heredados de GuiObjectPropiedades heredados de GuiBase2d
Ver todos los heredados de Instance

Métodos

Métodos heredados de GuiObject
Ver todos los heredados de Instance

Eventos

Eventos heredados de GuiObjectEventos heredados de GuiBase2d
Ver todos los heredados de Instance

Propiedades

AutoButtonColor

bool
leer paralelo

The AutoButtonColor 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 GUI and changing the element's ImageButton.HoverImage and ImageButton.PressedImage.

Please note that this property will not have an effect on an ImageButton if it's ImageButton.Image property is set to an image and is not null. Additionally, the property will not affect an ImageButton element on mouse hover when its ImageButton.HoverImage is not null nor on mouse click if ImageButton.PressedImage is not null.

Muestras de código

Changing a GUI Button's Color on Hover and Click
local button = script.Parent



if button:IsA("ImageButton") then

	if button.HoverImage and button.ClickImage then

		return

	end

end



button.AutoButtonColor = true
bool
leer paralelo

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

Selected

bool
leer paralelo

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

Style

Enum.ButtonStyle
leer paralelo

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

Ver todos los heredados de Instance

Métodos

Ver todos los heredados de Instance

Eventos

Activated

Fires when the button is activated.

Parámetros

inputObject: InputObject
clickCount: number

MouseButton1Click

The MouseButton1Click event fires when the user's Mouse fully left clicks the GUI button.

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

This event is similar to GuiButton.MouseButton2Click, which behaves identically except that it is connected to the user's right mouse button.

Note that this event will only fire for GUI buttons, including TextButtons and ImageButton. It will not fire for other GuiObjects.


Muestras de código

Handling User Clicks on a GUI Button
local button = script.Parent



local function leftClick()

	print("Left mouse click")

end



local function rightClick()

	print("Right mouse click")

end



button.MouseButton1Click:Connect(leftClick)

button.MouseButton2Click:Connect(rightClick)

MouseButton1Down

The MouseButton1Down event fires when the user presses their left Mouse button down on the GUI object.

This event is similar to GuiButton.MouseButton2Down, which behaves identically except that it is connected to the user's right mouse button.

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

Note that this event will only fire for GUI buttons, including TextButtons and ImageButton. It will not fire for other GuiObjects.

Parámetros

x: number

The mouse's x screen coordinate in pixels.

y: number

The mouse's y screen coordinate in pixels.


Muestras de código

Handling Right Mouse Button Up/Down on a GUI Button
local button = script.Parent



local function leftMouseButtonUp(x, y)

	print("Left mouse up at", x, y)

end



local function leftMouseButtonDown(x, y)

	print("Left mouse down at", x, y)

end



button.MouseButton1Up:Connect(leftMouseButtonUp)

button.MouseButton1Down:Connect(leftMouseButtonDown)

MouseButton1Up

The MouseButton1Up event fires when the user releases their left Mouse up off of the GUI object.

This event is similar to GuiButton.MouseButton2Up, which behaves identically except that it is connected to the user's right mouse button.

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

Note that this event will only fire for GUI buttons, including TextButtons and ImageButton. It will not fire for other GuiObjects.

Parámetros

x: number

The mouse's x screen coordinate in pixels.

y: number

The mouse's y screen coordinate in pixels.


Muestras de código

Handling Right Mouse Button Up/Down on a GUI Button
local button = script.Parent



local function leftMouseButtonUp(x, y)

	print("Left mouse up at", x, y)

end



local function leftMouseButtonDown(x, y)

	print("Left mouse down at", x, y)

end



button.MouseButton1Up:Connect(leftMouseButtonUp)

button.MouseButton1Down:Connect(leftMouseButtonDown)

MouseButton2Click

The MouseButton2Click event fires when the user's Mouse fully right clicks the GUI button.

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

This event is similar to GuiButton.MouseButton1Click, which behaves identically except that it is connected to the user's left mouse button.

Note that this event will only fire for GUI buttons, including TextButtons and ImageButton. It will not fire for other GuiObjects.


Muestras de código

GUI Button Right Click
local button = script.Parent.Button



local function rightClick()

	print("Right click pressed down and up on button.")

end



button.MouseButton2Click:Connect(rightClick)

MouseButton2Down

The MouseButton2Down event fires when the user presses their left Mouse button down on the GUI object.

This event is similar to GuiButton.MouseButton1Down, which behaves identically except that it is connected to the user's left mouse button.

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

Note that this event will only fire for GUI buttons, including TextButtons and ImageButton. It will not fire for other GuiObjects.

Parámetros

x: number

The mouse's x screen coordinate in pixels.

y: number

The mouse's y screen coordinate in pixels.


Muestras de código

Handling Left Mouse Button Up/Down on a GUI Button
local gui = script.Parent

local button = gui.Button



function rightMouseButtonUp(x, y)

	print("Right mouse up", x, y)

end



function rightMouseButtonDown(x, y)

	print("Right mouse down", x, y)

end



button.MouseButton2Up:Connect(rightMouseButtonUp)

button.MouseButton2Down:Connect(rightMouseButtonDown)

MouseButton2Up

The MouseButton2Up event fires when the user releases their right Mouse up off of the GUI object.

This event is similar to GuiButton.MouseButton1Up, which behaves identically except that it is connected to the user's left mouse button.

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

Note that this event will only fire for GUI buttons, including TextButtons and ImageButton. It will not fire for other GuiObjects.

Parámetros

x: number

The mouse's x screen coordinate in pixels.

y: number

The mouse's y screen coordinate in pixels.


Muestras de código

Handling Left Mouse Button Up/Down on a GUI Button
local gui = script.Parent

local button = gui.Button



function rightMouseButtonUp(x, y)

	print("Right mouse up", x, y)

end



function rightMouseButtonDown(x, y)

	print("Right mouse down", x, y)

end



button.MouseButton2Up:Connect(rightMouseButtonUp)

button.MouseButton2Down:Connect(rightMouseButtonDown)
Ver todos los heredados de Instance