rebar/io.github.pylonmc.rebar.guide.pages.base/SimpleStaticGuidePage

SimpleStaticGuidePage

open class SimpleStaticGuidePage @JvmOverloads constructor(key: NamespacedKey, val buttons: MutableList<Item> = mutableListOf()) : SimpleDynamicGuidePage(source)

A guide page which has a fixed set of buttons. Do not use this if the buttons on the page will ever need to change.

The title of the page will be <youraddon>.guide.page.<key>

See also

Inheritors

Constructors

Link copied to clipboard
@JvmOverloads
constructor(key: NamespacedKey, buttons: MutableList<Item> = mutableListOf())
constructor(key: NamespacedKey, vararg buttons: Item)

Properties

Link copied to clipboard
val buttons: MutableList<Item>

The list of buttons to be displayed on this page.

Link copied to clipboard
val buttonSupplier: Supplier<List<Item>>

Supplies the buttons to be displayed on this page.

Link copied to clipboard
open override val key: NamespacedKey
Link copied to clipboard
open val title: Component

The title of this page, displayed at the top of the GUI when the page is open.

Functions

Link copied to clipboard
open fun addButton(button: Item): Boolean
Link copied to clipboard
open fun addFluid(fluid: RebarFluid): Boolean
Link copied to clipboard
open fun addItem(item: ItemStack): Boolean
Link copied to clipboard
open fun addPage(builder: ItemStackBuilder, page: GuidePage): Boolean
open fun addPage(material: Material, page: GuidePage): Boolean
open fun addPage(stack: ItemStack, page: GuidePage): Boolean
Link copied to clipboard
open fun addResearch(research: Research): Boolean
Link copied to clipboard
open override fun getGui(player: Player): Gui

Created the page for the given player.

Link copied to clipboard
open fun getHeader(player: Player, buttons: List<Item>): PagedGui.Builder<Item?>?

Returns a page containing the header (the top row of the page) and a section for the items to go.

Link copied to clipboard
open override fun getKey(): NamespacedKey
Link copied to clipboard
open fun key(): @NotNull Key
Link copied to clipboard
open fun loadCurrentPage(player: Player, gui: PagedGui<*>)
Link copied to clipboard
open fun open(player: Player)

Opens the GUI for a player.

Link copied to clipboard
open fun saveCurrentPage(player: Player, page: Int)
Link copied to clipboard
open fun shouldDisplay(player: Player): Boolean

Should the page be displayed to said player? If not it won't be added to the button list

Generated by Dokka
© 2026 Copyright