rebar/io.github.pylonmc.rebar.item/RebarItem

RebarItem

open class RebarItem(val stack: ItemStack) : Keyed(source)

RebarItems are wrappers around ItemStacks that allow you to easily add extra functionality.

Unlike RebarBlock and RebarEntity, RebarItem isn't persisted in memory, so you should avoid storing any fields in your RebarItem classes. Instead, use the stack's PersistentDataContainer to store data persistently.

An implementation of RebarItem must have a constructor that takes an ItemStack as its only parameter. This will be used to load an in-world ItemStack as this particular RebarItem class.

Inheritors

Constructors

constructor(stack: ItemStack)

Types

object Companion

Properties

val addon: RebarAddon

val isDisabled: Boolean

open override val key: NamespacedKey

val rebarBlock: NamespacedKey?

val research: Research?

val schema: RebarItemSchema

Additional data about the item's type.

val stack: ItemStack

Functions

open operator override fun equals(other: Any?): Boolean

open override fun getKey(): NamespacedKey

getPlaceholders

open fun getPlaceholders(): List<RebarArgument>

Returns the list of placeholders to be substituted into the item's lore.

fun <T> getSetting(key: String, adapter: ConfigAdapter<T>): T?

fun <T> getSetting(key: String, adapter: ConfigAdapter<T>, defaultValue: T): T

fun <T> getSetting(key: String, adapter: ConfigAdapter<T>, defaultValue: () -> T): T

Shorthand for getSettings().get(...)

getSettingOrThrow

fun <T> getSettingOrThrow(key: String, adapter: ConfigAdapter<T>): T

Shorthand for getSettings().getOrThrow(...)

fun getSettings(): ConfigSection

Returns settings associated with the item.

open override fun hashCode(): Int

open fun key(): @NotNull Key

open fun place(context: BlockCreateContext): RebarBlock?

Places the block associated with this item, if it exists.

open fun prePlace(context: BlockCreateContext): Boolean

Checks if the block associated with this item can be placed in the given context.