NollyAPI/com.thenolle.api.nollyapi.util.gui.core/ButtonBuilder

ButtonBuilder

A builder class for creating a GuiButton with various configuration options.

This class allows you to define the behavior, appearance, and additional properties of a button in a GUI. You can customize the button's item, click actions, animations, and other properties using this builder.

Constructors

ButtonBuilder

constructor()

Properties

animationFrames

var animationFrames: List<ItemStack>

A list of item frames for animating the button.

animationInterval

var animationInterval: Long

The interval (in ticks) between animation frames.

debounce

var debounce: Long

The debounce time (in ticks) to prevent multiple clicks in quick succession.

delay

var delay: Long

The delay (in ticks) before the button's action is triggered.

item

var item: ItemStack?

The item that represents the button.

metadata

val metadata: MutableMap<String, Any>

The metadata associated with the button.

onClick

var onClick: (InventoryClickEvent) -> Unit?

The action to be performed when the button is clicked.

scope

var scope: EventScope<InventoryClickEvent>.() -> Unit

The event scope that defines the conditions for this button's action to be triggered.

throttle

var throttle: Long

The throttle time (in milliseconds) to limit how frequently the button action can be triggered.

Functions

build

fun build(): GuiButton

Builds the GuiButton with the defined properties.

chainRedirect

fun chainRedirect(from: GuiBuilder, to: GuiBuilder)

Sets up a chain redirection from this button to another GUI builder when clicked.

frames

fun frames(vararg frames: ItemStack): ButtonBuilder

Adds frames for animating the button.

interval

fun interval(ticks: Long): ButtonBuilder

Sets the interval (in ticks) between animation frames.

redirectTo

fun redirectTo(from: GuiBuilder, to: GuiBuilder)

Sets up a redirection from this button to another GUI builder when clicked.

redirectToWithMeta

fun redirectToWithMeta(from: GuiBuilder, to: GuiBuilder, meta: Map<String, Any>)

Sets up a redirection with metadata from this button to another GUI builder when clicked.