GuiButton

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.

local button = script.Parent

if button:IsA("ImageButton") then
	if button.HoverImage and button.ClickImage then
		return
	end
end

button.AutoButtonColor = true

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

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

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

Fires when the button is activated.

Parameters

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.

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)

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.

Parameters

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)

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.

Parameters

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)

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.

function rightClick()
	print("Right mouse click")
end

script.Parent.MouseButton2Click:Connect(rightClick)

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.

Parameters

function rightMouseButtonUp(x, y)
	print("Right mouse up", x, y)
end

function rightMouseButtonDown(x, y)
	print("Right mouse down", x, y)
end

script.Parent.MouseButton2Up:Connect(rightMouseButtonUp)
script.Parent.MouseButton2Down:Connect(rightMouseButtonDown)

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.

Parameters

function rightMouseButtonUp(x, y)
	print("Right mouse up", x, y)
end

function rightMouseButtonDown(x, y)
	print("Right mouse down", x, y)
end

script.Parent.MouseButton2Up:Connect(rightMouseButtonUp)
script.Parent.MouseButton2Down:Connect(rightMouseButtonDown)