pylon-core/io.github.pylonmc.pylon.core.guide.pages/PlayerSettingsPage

PlayerSettingsPage

class PlayerSettingsPage(key: NamespacedKey = pylonKey("settings"), val material: Material = Material.COMPARATOR, val buttons: MutableList<Item> = mutableListOf()) : SimpleStaticGuidePage(source)

Contains buttons to change player settings.

Constructors

Link copied to clipboard
constructor(key: NamespacedKey = pylonKey("settings"), material: Material = Material.COMPARATOR, buttons: MutableList<Item> = mutableListOf())

Types

Link copied to clipboard
object Companion

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 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.

Link copied to clipboard
val material: Material

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

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 addFluid(fluid: PylonFluid): Boolean
Link copied to clipboard
open fun addItem(item: ItemStack): Boolean
Link copied to clipboard
open fun addPage(page: GuidePage): Boolean
Link copied to clipboard
open fun addResearch(research: Research): Boolean
Link copied to clipboard
fun addSetting(item: Item)
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>): @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.

Link copied to clipboard
open override fun getKey(): NamespacedKey
Link copied to clipboard
open override 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)