pylon-core/io.github.pylonmc.pylon.core.guide.button.setting

Package-level declarations

Types

data class CyclePlayerSettingButton<S>(val key: NamespacedKey, val sortedValues: List<S>, val identifier: (S) -> String, val getter: (Player) -> S, val setter: (Player, S) -> Unit, val decorator: (Player, S) -> ItemStack, val placeholderProvider: (Player, S) -> MutableList<ComponentLike> = { _, _ -> mutableListOf<ComponentLike>() }) : AbstractItem

A button which cycles through a fixed set of values for a player setting. (Think enums for example.)

data class NumericPlayerSettingButton<N : Number>(val key: NamespacedKey, val min: N, val max: N, val step: N, val shiftStep: N, val type: (Number) -> N, val getter: (Player) -> N, val setter: (Player, N) -> Unit, val decorator: (Player, N) -> ItemStack, val placeholderProvider: (Player, N) -> MutableList<ComponentLike> = { _, setting -> mutableListOf<ComponentLike>( PylonArgument.of("value", Component.text(setting.toString())) ) }) : AbstractItem

A button for changing a numeric setting for a player. (e.g. volume, brightness, etc.)

data class TogglePlayerSettingButton(val key: NamespacedKey, val isEnabled: (Player) -> Boolean, val toggle: (Player) -> Unit, val decorator: (Player, Boolean) -> ItemStack = { _, toggled -> if (toggled) ItemStack(Material.LIME_CONCRETE) else ItemStack(Material.RED_CONCRETE) }, val placeholderProvider: (Player, Boolean) -> MutableList<ComponentLike> = { _, _ -> mutableListOf<ComponentLike>() }) : AbstractItem

A button which toggles a boolean setting for a player.