Button

Class Name: GNUI.Button

an element that allows the user to click on it.

Quick example on making a button and doing something when clicking it.

local GNUI = require"GNUI.main"
local Button = require"GNUI.element.button"
local screen = GNUI.getScreenCanvas()

local btn = Button.new(screen)
---@type GNUI.InputEvent
btn.PRESSED:register(function ()
  -- clicked
end)

Properties

Type	Field	Description
GNUI.Box	HoverBox	...
boolean	isPressed	...
boolean	isToggle	...
GNUI.keyCode	keybind	...

Events

Event	Description
BUTTON_CHANGED	...
BUTTON_DOWN	...
BUTTON_UP	...
PRESSED	...

Methods

Returns	Methods
GNUI.Button	Button.new(parent : GNUI.Box?, variant : string｜"none"｜"default"?)
self	Button:setToggle(toggle : boolean)
self	Button:press()
self	Button:click()
self	Button:release()

Button.new(parent, variant)

Arguments

• GNUI.Box? parent

• string|"none"|"default"? variant

Returns GNUI.Button

Button:setToggle(toggle)

Sets whether the button is toggleable

Arguments

• boolean toggle

Returns self

Button:press()

Presses the button. or if the button is a toggle and is pressed, this releases the button.

Arguments

Returns self

Button:click()

Presses and releases the button.

Arguments

Returns self

Button:release()

Releases the button, if the button is not a toggle, if it is, call press() again to release.

Arguments

Returns self