GuiButton

extends GuiObject

Class fields

FieldXML typeValue
NamestringGuiButton
summarystringA GUI button containing an Image
Browsableboolfalse
ExplorerOrderstring16
ExplorerImageIndexstring52

Properties

10
AutoButtonColor
bool
FieldXML typeValue
NamestringAutoButtonColor
summarystringDetermines whether a button changes color automatically when reacting to mouse events.
Modal
bool
FieldXML typeValue
NamestringModal
summarystringAllows the mouse to be free in first person mode. If a button with this property set to true is visible, the mouse is 'free' in first person mode.
MouseButton1ClickConnectionCount
int
FieldXML typeValue
NamestringMouseButton1ClickConnectionCount
MouseButton1DownConnectionCount
int
FieldXML typeValue
NamestringMouseButton1DownConnectionCount
MouseButton1UpConnectionCount
int
FieldXML typeValue
NamestringMouseButton1UpConnectionCount
MouseButton2ClickConnectionCount
int
FieldXML typeValue
NamestringMouseButton2ClickConnectionCount
MouseButton2DownConnectionCount
int
FieldXML typeValue
NamestringMouseButton2DownConnectionCount
MouseButton2UpConnectionCount
int
FieldXML typeValue
NamestringMouseButton2UpConnectionCount
Selected
bool
FieldXML typeValue
NamestringSelected
Style
ButtonStyle
FieldXML typeValue
NamestringStyle
summarystringDetermines how a button will look, including mouse event states. Uses Enum.ButtonStyle. <a href="http://wiki.roblox.com/index.php?title=API:Class/GuiButton/Style" target="_blank">More info</a>

Functions

1
SetVerb
(verb: string) → void
FieldXML typeValue
NamestringSetVerb

Events

6
MouseButton1Click
() → void
FieldXML typeValue
NamestringMouseButton1Click
summarystringFired when the mouse is over the button, and the mouse down and up events fire without the mouse leaving the button.
MouseButton1Down
(x: int, y: int) → void
FieldXML typeValue
NamestringMouseButton1Down
summarystringFired when the mouse button is pushed down on a button.
MouseButton1Up
(x: int, y: int) → void
FieldXML typeValue
NamestringMouseButton1Up
summarystringFired when the mouse button is released on a button.
MouseButton2Click
() → void
FieldXML typeValue
NamestringMouseButton2Click
summarystringThis function currently does not work :(
MouseButton2Down
(x: int, y: int) → void
FieldXML typeValue
NamestringMouseButton2Down
summarystringThis function currently does not work :(
MouseButton2Up
(x: int, y: int) → void
FieldXML typeValue
NamestringMouseButton2Up
summarystringThis function currently does not work :(