ImageButton
An interactive GUI button rendered with an image.
- Creatable
Instance.new("ImageButton")- Inherits
- GuiButtonGuiObjectGuiBase2dGuiBaseInstance
- Replication
- Standard
Behavior
ImageButton displays an image and receives pointer, touch, or gamepad
activation. It also exposes the text-style fields provided by the shared GUI
label surface.
Summary
The resolved top-left position of this interface element in pixels.
The resolved rotation of this interface element in degrees, including ancestor rotation.
The resolved width and height of this interface element in pixels.
Whether this interface accepts and consumes input.
The normalized point within the element used as the origin for Position.
Whether the button automatically changes color during pointer interaction.
The dimensions that resize to fit the element's content.
The color used to fill the element's background.
The background transparency, from 0 for opaque to 1 for invisible.
The color of the element's border.
Whether the border is drawn outside, across, or inside the element's bounds.
The border thickness in pixels.
Whether descendant rendering is clipped to this element's bounds.
The corner radius used for the element's rounded background.
The individual corner radii used for the element's rounded background.
Whether pointer dragging can move the element.
The share of remaining main-axis space assigned to this child in flow layout.
The element's current idle, hover, pressed, or non-interactable state.
The content identifier of the displayed image.
The tint multiplied into the image color.
The top-left pixel offset of the image region to display.
The size in pixels of the image region to display.
The image transparency, from 0 for opaque to 1 for invisible.
Which input events this element consumes before they reach elements behind it.
Whether the element accepts interaction.
Whether children use flow layout or their explicit positions.
The numeric order of this element when a parent layout sorts by layout order.
Whether the button captures modal interface input.
The interface element selected when navigating down from this element.
The interface element selected when navigating left from this element.
The interface element selected when navigating right from this element.
The interface element selected when navigating up from this element.
The opacity multiplier applied to this element and its descendants.
The element position relative to its parent.
The sampling method used when scaling the image.
The interface rotation in degrees.
Whether the image stretches, slices, tiles, fits, or crops to its bounds.
Whether interface navigation can select this element.
The interface element used to draw the selection indicator.
The numeric order used for interface selection traversal.
The element size relative to its parent.
The parent axes used to resolve relative interface size.
The inner rectangle used for nine-slice image scaling.
The scale applied to the borders of a nine-slice image.
The size of one repeated tile when the image uses tile scaling.
Whether this interface element is rendered.
The element's draw-order index.
Gives keyboard focus to this interface element.
Returns this instance if it is an ExecutionGroup.
Removes keyboard focus from this interface element.
Fires when the button is activated by an accepted pointer, touch, or gamepad input.
Fires when pointer dragging of the element begins.
Fires when pointer dragging of the element ends.
Fires when input begins over or is dispatched to this interface element.
Fires when input dispatched to this element changes.
Fires when input dispatched to this element ends.
Fires when the mouse wheel scrolls backward over this element.
Fires when the mouse wheel scrolls forward over this element.
Fires when a pointer moves onto the button.
Fires when a pointer moves off the button.
Fires when the pointer moves across the button.
Fires when the button enters its pressed state.
Fires when the button leaves its pressed state.
Fires when interface navigation selects this element.
Fires when this element loses interface selection.
Properties
AbsolutePosition
ImageButton.AbsolutePosition: Vector2 = Vector2.new(0, 0)The resolved top-left position of this interface element in pixels.
AbsoluteRotation
ImageButton.AbsoluteRotation: number = 0The resolved rotation of this interface element in degrees, including ancestor rotation.
AbsoluteSize
ImageButton.AbsoluteSize: Vector2 = Vector2.new(0, 0)The resolved width and height of this interface element in pixels.
Active
ImageButton.Active: boolean = trueWhether this interface accepts and consumes input.
AnchorPoint
ImageButton.AnchorPoint: Vector2 = Vector2.new(0, 0)The normalized point within the element used as the origin for Position. (0, 0) is the top-left corner; (0.5, 0.5) is the center.
AutoButtonColor
ImageButton.AutoButtonColor: boolean = trueWhether the button automatically changes color during pointer interaction.
AutomaticSize
ImageButton.AutomaticSize: Enum.AutomaticSize = Enum.AutomaticSize.NoneThe dimensions that resize to fit the element's content.
BackgroundColor3
ImageButton.BackgroundColor3: Color3 = Color3.new(0.6392157, 0.63529414, 0.64705884)The color used to fill the element's background.
BackgroundTransparency
ImageButton.BackgroundTransparency: number = 0The background transparency, from 0 for opaque to 1 for invisible.
BorderColor3
ImageButton.BorderColor3: Color3 = Color3.new(0.105882354, 0.16470589, 0.20784314)The color of the element's border.
BorderMode
ImageButton.BorderMode: Enum.BorderMode = Enum.BorderMode.OutlineWhether the border is drawn outside, across, or inside the element's bounds.
BorderSizePixel
ImageButton.BorderSizePixel: number = 1The border thickness in pixels.
ClipsDescendants
ImageButton.ClipsDescendants: boolean = falseWhether descendant rendering is clipped to this element's bounds.
CornerRadius
ImageButton.CornerRadius: number = 0The corner radius used for the element's rounded background.
Corners
ImageButton.Corners: { number } = {}The individual corner radii used for the element's rounded background.
Draggable
ImageButton.Draggable: boolean = falseWhether pointer dragging can move the element.
Grow
ImageButton.Grow: number = 0The share of remaining main-axis space assigned to this child in flow layout.
GuiState
ImageButton.GuiState: Enum.GuiState = Enum.GuiState.IdleThe element's current idle, hover, pressed, or non-interactable state.
Image
ImageButton.Image: Content = ""The content identifier of the displayed image.
ImageColor3
ImageButton.ImageColor3: Color3 = Color3.new(1, 1, 1)The tint multiplied into the image color.
ImageRectOffset
ImageButton.ImageRectOffset: Vector2 = Vector2.new(0, 0)The top-left pixel offset of the image region to display.
ImageRectSize
ImageButton.ImageRectSize: Vector2 = Vector2.new(0, 0)The size in pixels of the image region to display.
ImageTransparency
ImageButton.ImageTransparency: number = 0The image transparency, from 0 for opaque to 1 for invisible.
InputSink
ImageButton.InputSink: Enum.InputSink = Enum.InputSink.NoneWhich input events this element consumes before they reach elements behind it.
Interactable
ImageButton.Interactable: boolean = trueWhether the element accepts interaction.
Layout
ImageButton.Layout: Enum.Layout = Enum.Layout.FlowWhether children use flow layout or their explicit positions.
LayoutOrder
ImageButton.LayoutOrder: number = 0The numeric order of this element when a parent layout sorts by layout order.
Modal
ImageButton.Modal: boolean = falseWhether the button captures modal interface input.
NextSelectionDown
ImageButton.NextSelectionDown: GuiObject? = nilThe interface element selected when navigating down from this element.
NextSelectionLeft
ImageButton.NextSelectionLeft: GuiObject? = nilThe interface element selected when navigating left from this element.
NextSelectionRight
ImageButton.NextSelectionRight: GuiObject? = nilThe interface element selected when navigating right from this element.
NextSelectionUp
ImageButton.NextSelectionUp: GuiObject? = nilThe interface element selected when navigating up from this element.
Opacity
ImageButton.Opacity: number = 1The opacity multiplier applied to this element and its descendants.
Position
The element position relative to its parent. Scale components use the parent size; offsets are in pixels.
ResampleMode
ImageButton.ResampleMode: Enum.ResamplerMode = Enum.ResamplerMode.DefaultThe sampling method used when scaling the image.
Rotation
ImageButton.Rotation: number = 0The interface rotation in degrees.
ScaleType
ImageButton.ScaleType: Enum.ScaleType = Enum.ScaleType.StretchWhether the image stretches, slices, tiles, fits, or crops to its bounds.
Selectable
ImageButton.Selectable: boolean = falseWhether interface navigation can select this element.
SelectionImageObject
ImageButton.SelectionImageObject: GuiObject? = nilThe interface element used to draw the selection indicator.
SelectionOrder
ImageButton.SelectionOrder: number = 0The numeric order used for interface selection traversal.
Size
The element size relative to its parent. Scale components use the parent size; offsets are in pixels.
SizeConstraint
ImageButton.SizeConstraint: Enum.SizeConstraint = Enum.SizeConstraint.RelativeXYThe parent axes used to resolve relative interface size.
SliceCenter
The inner rectangle used for nine-slice image scaling.
SliceScale
ImageButton.SliceScale: number = 1The scale applied to the borders of a nine-slice image.
TileSize
The size of one repeated tile when the image uses tile scaling.
Visible
ImageButton.Visible: boolean = trueWhether this interface element is rendered.
ZIndex
ImageButton.ZIndex: number = 1The element's draw-order index. Interpretation depends on the root's ZIndexBehavior.
Methods
CaptureFocus
ImageButton:CaptureFocus(): ()Gives keyboard focus to this interface element.
GetExecutionGroup
ImageButton:GetExecutionGroup(): ExecutionGroup?Returns this instance if it is an ExecutionGroup. Otherwise returns the nearest ancestor ExecutionGroup, or nil when no group contains the instance.
ReleaseFocus
ImageButton:ReleaseFocus(): ()Removes keyboard focus from this interface element.
Events
Activated
ImageButton.Activated: RBXScriptSignalFires when the button is activated by an accepted pointer, touch, or gamepad input.
DragBegin
ImageButton.DragBegin: RBXScriptSignalFires when pointer dragging of the element begins.
DragStopped
ImageButton.DragStopped: RBXScriptSignalFires when pointer dragging of the element ends.
InputBegan
ImageButton.InputBegan: RBXScriptSignalFires when input begins over or is dispatched to this interface element.
InputChanged
ImageButton.InputChanged: RBXScriptSignalFires when input dispatched to this element changes.
InputEnded
ImageButton.InputEnded: RBXScriptSignalFires when input dispatched to this element ends.
MouseWheelBackward
ImageButton.MouseWheelBackward: RBXScriptSignalFires when the mouse wheel scrolls backward over this element.
MouseWheelForward
ImageButton.MouseWheelForward: RBXScriptSignalFires when the mouse wheel scrolls forward over this element.
PointerEntered
ImageButton.PointerEntered: RBXScriptSignalFires when a pointer moves onto the button.
PointerExited
ImageButton.PointerExited: RBXScriptSignalFires when a pointer moves off the button.
PointerMoved
ImageButton.PointerMoved: RBXScriptSignalFires when the pointer moves across the button.
Pressed
ImageButton.Pressed: RBXScriptSignalFires when the button enters its pressed state.
Released
ImageButton.Released: RBXScriptSignalFires when the button leaves its pressed state.
SelectionGained
ImageButton.SelectionGained: RBXScriptSignalFires when interface navigation selects this element.
SelectionLost
ImageButton.SelectionLost: RBXScriptSignalFires when this element loses interface selection.
Inherited members
- Properties
- CatchesPointer
- Properties
- ArchivableClassNameNameParent
- Methods
- AddComponent()AddTag()ClearAllChildren()ClearTags()Clone()Destroy()FindFirstAncestor()FindFirstAncestorOfClass()FindFirstAncestorWhichIsA()FindFirstChild()FindFirstChildOfClass()FindFirstChildWhichIsA()FindFirstDescendant()GetAttribute()GetAttributeChangedSignal()GetAttributes()GetChildren()GetComponent()GetComponentChangedSignal()GetComponents()GetDebugId()GetDescendants()GetFullName()GetPropertyChangedSignal()GetReferencing()GetTags()HasComponent()HasTag()IsA()IsAncestorOf()IsDescendantOf()RemoveComponent()RemoveTag()SetAttribute()WaitForChild()
- Events
- AncestryChangedAttributeChangedChangedChildAddedChildRemovedDescendantAddedDescendantRemovingDestroying
Example
local button = Instance.new("ImageButton")
button.Image = "astasset://ui/save.png"
button.Activated:Connect(function()
print("save")
end)