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

SimpleDynamicGuidePage

open class SimpleDynamicGuidePage(key: NamespacedKey, val buttonSupplier: Supplier<List<Item>>) : PagedGuidePage(source)

A simple page that just displays an arbitrary number of items with a header. For example, the research page just displays all the researches for a given addon, with next/previous page buttons and a header.

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

Next/previous buttons are only shown if there are multiple pages.

Inheritors

SimpleStaticGuidePage

AddonContributorsPage

ContributorsPage

AddonResearchesPage

ResearchesPage

Constructors

SimpleDynamicGuidePage

constructor(key: NamespacedKey, buttonSupplier: Supplier<List<Item>>)

Properties

buttonSupplier

val buttonSupplier: Supplier<List<Item>>

Supplies the buttons to be displayed on this page.

key

open override val key: NamespacedKey

title

open val title: Component

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

Functions

getGui

open override fun getGui(player: Player): Gui

Created the page for the given player.

getHeader

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.

getKey

open override fun getKey(): NamespacedKey

key

open 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)

shouldDisplay

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