ImageButton

ImageButton : GuiButton

Overview

ImageButton displays image just like ImageLabel, but it adds interactable buttons. In other words, it is a UI element that displays image as well as uses the events of GuiButton like click and tap.

ImageButton can be controlled only in client environment.

Properties

HoverImage

string

Specifies image asset to be displayed when the mouse cursor is hovering on ImageButton.

Code Samples

local ScreenGui = script.Parent
local ImageButton = ScreenGui:WaitForChild("ImageButton")

ImageButton.HoverImage = "ovdrassetid://1234"

HoverImageContent

Content

Currently not supported.

Code Samples

Image

string

Specifies image asset to be displayed in ImageButton.

Code Samples

local ScreenGui = script.Parent
local ImageButton = ScreenGui:WaitForChild("ImageButton")

ImageButton.Image = "ovdrassetid://1234"

ImageColor3

Color3

Specifies the color to be applied to image.

If color is left white, original image will be displayed. If some other color is specified, the whole image will be in that hue.

Code Samples

local ScreenGui = script.Parent
local ImageButton = ScreenGui:WaitForChild("ImageButton")

ImageButton.ImageColor3 = Color3.fromRGB(255, 0, 0)

ImageContent

Content

Currently not supported.

Code Samples

ImageTransparency

number

Specifies the transparency of image.

0 means the image is completely opaque while 1 means the image is totally invisible.

If background needs to be hidden while image is displayed, set BackgroundTransparency to 1.

Code Samples

local ScreenGui = script.Parent
local ImageButton = ScreenGui:WaitForChild("ImageButton")

ImageButton.ImageTransparency = 0.5

PressImage

string

Specifies image asset to be displayed when ImageButton is pushed.

Code Samples

local ScreenGui = script.Parent
local ImageButton = ScreenGui:WaitForChild("ImageButton")

ImageButton.PressImage = "ovdrassetid://1234"

PressImageContent

Content

Currently not supported.

Code Samples

Methods

Events

See also

GUI