silk-igui/net.silkmc.silk.igui/GuiBuilder/PageBuilder

PageBuilder

inner class PageBuilder(val key: String, val number: Int)(source)

Constructors

constructor(key: String, number: Int)

Properties

Effect used for transitions from this page. If this is not null and effectTo is null, this will be used as a fallback.

effectTo

var effectTo: GuiPage.ChangeEffect?

Effect used for transitions to this page. If this is not null, it will always be used even if effectFrom is not null aswell.

key

val key: String

number

val number: Int

Functions

button

fun button(slots: GuiSlotCompound, icon: GuiIcon, onClick: suspend (GuiClickEvent) -> Unit)

Adds a button. A button has custom onClick logic.

changePageByKey

fun changePageByKey(slots: GuiSlotCompound, icon: GuiIcon, pageKey: Any, shouldChange: suspend (GuiClickEvent) -> Boolean = { true }, onChange: suspend (GuiClickEvent) -> Unit? = null)

Adds a page change button, which will open the specified page when clicked.

changePageByNumber

fun changePageByNumber(slots: GuiSlotCompound, icon: GuiIcon, pageNumber: Int, shouldChange: suspend (GuiClickEvent) -> Boolean = { true }, onChange: suspend (GuiClickEvent) -> Unit? = null)

Adds a page change button, which will open the specified page when clicked.

compound

fun <E> compound(slots: GuiSlotCompound.SlotRange.Rectangle, content: AbstractGuiList<E, List<E>>, iconGenerator: suspend (E) -> ItemStack, onClick: suspend (event: GuiClickEvent, element: E) -> Unit? = null): GuiCompound<E>

Creates a new rectangular compound (startSlot and endSlot define the corners of the compound).

compoundScroll

fun compoundScroll(slots: GuiSlotCompound, icon: GuiIcon, compound: GuiCompound<*>, reverse: Boolean, speed: Duration = 1.ticks, scrollDistance: Int = compound.compoundWidth, scrollTimes: Int = compound.compoundHeight)

Adds a compound scroll button.

compoundScrollBackwards

fun compoundScrollBackwards(slots: GuiSlotCompound, icon: GuiIcon, compound: GuiCompound<*>, speed: Duration = 1.ticks, scrollTimes: Int = compound.compoundHeight)

Adds a compound scroll button.

compoundScrollForwards

fun compoundScrollForwards(slots: GuiSlotCompound, icon: GuiIcon, compound: GuiCompound<*>, speed: Duration = 1.ticks, scrollTimes: Int = compound.compoundHeight)

Adds a compound scroll button.

element

fun element(guiSlotCompound: GuiSlotCompound, element: GuiElement)

Adds the given element for each given slot to the gui.

freeSlot

fun freeSlot(slots: GuiSlotCompound, onClick: suspend (GuiClickEvent) -> Unit? = null)

Adds a free slot. A free slot allows player interaction.

fun nextPage(slots: GuiSlotCompound, icon: GuiIcon, shouldChange: suspend (GuiClickEvent) -> Boolean = { true }, onChange: suspend (GuiClickEvent) -> Unit? = null)

Adds a page change button, which will open the next page when clicked.

placeholder

fun placeholder(slots: GuiSlotCompound, icon: GuiIcon)

Adds a placeholder. A placeholder ignores any click actions.

fun previousPage(slots: GuiSlotCompound, icon: GuiIcon, shouldChange: suspend (GuiClickEvent) -> Boolean = { true }, onChange: suspend (GuiClickEvent) -> Unit? = null)

Adds a page change button, which will open the previous page when clicked.

setEffect

fun setEffect(effect: GuiPage.ChangeEffect?)

Sets both effectTo and effectFrom at the same time.