1.0.0-SNAPSHOT

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

PagedGuidePage

interface PagedGuidePage : GuidePage(source)

Represents a GuidePage with multiple pages When building your PagedGui add a page change handler using saveCurrentPage to remember page changes After constructing your PagedGui, use loadCurrentPage to set the correct page for the player

For example:

override fun getGui(player: Player): Gui {
   val gui = PagedGui.items()
       .setStructure(...)
       ...
       .addPageChangeHandler { _, newPage -> saveCurrentPage(player, newPage) }
   return gui.build().apply { loadCurrentPage(player, this) }
}

Inheritors

SimpleDynamicGuidePage

FluidRecipesPage

FluidUsagesPage

ItemRecipesPage

Types

object Companion

Properties

abstract val item: ItemProvider

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

open val title: Component

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

Functions

abstract fun getGui(player: Player): Gui

Created the page for the given player.

@NotNull

abstract fun getKey(): @NotNull NamespacedKey

open override fun key(): @NotNull Key

loadCurrentPage

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

open fun open(player: Player)

Opens the GUI for a player.

saveCurrentPage

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