pylon-core/io.github.pylonmc.pylon.core.guide.pages.base/SimpleStaticGuidePage

SimpleStaticGuidePage

open class SimpleStaticGuidePage @JvmOverloads constructor(key: NamespacedKey, val material: Material, 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 need to change at runtime.

Inheritors

Constructors

@JvmOverloads

constructor(key: NamespacedKey, material: Material, buttons: MutableList<Item> = mutableListOf())

Properties

buttons

val buttons: MutableList<Item>

The list of buttons to be displayed on this page.

buttonSupplier

val buttonSupplier: Supplier<List<Item>>

Supplies the buttons to be displayed on this page.

item

open override val item: ItemStackBuilder

The item representing this page. This will be used in any io.github.pylonmc.pylon.core.guide.button.PageButtons that point to this page.

material

val material: Material

The material representing this page. Used for PageButtons that point to this page.

title

open val title: Component

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

Functions

addFluid

open fun addFluid(fluid: PylonFluid): Boolean

addItem

open fun addItem(item: ItemStack): Boolean

addPage

open fun addPage(page: GuidePage): Boolean

addResearch

open fun addResearch(research: Research): Boolean

getGui

open override fun getGui(player: Player): Gui

Created the page for the given player.

getHeader

open fun getHeader(player: Player, buttons: List<Item>): @NotNull PagedGui.Builder<@NotNull Item>

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

getKey

open override fun getKey(): NamespacedKey

key

open override fun key(): @NotNull Key

loadCurrentPage

open fun loadCurrentPage(player: Player, gui: PagedGui<*>)

open

open fun open(player: Player)

Opens the GUI for a player.

saveCurrentPage

open fun saveCurrentPage(player: Player, page: Int)