api/org.kryptonmc.api.item.meta

Package-level declarations

Types

interface BannerMeta : ScopedItemMeta<BannerMeta.Builder, BannerMeta>

Item metadata for a banner.

interface BookMeta<B : BookMeta.Builder<B, I>, I : BookMeta<B, I>> : ScopedItemMeta<B, I>

Contains shared metadata between WritableBookMeta and WrittenBookMeta.

interface BundleMeta : ScopedItemMeta<BundleMeta.Builder, BundleMeta>

Item metadata for a bundle.

interface CompassMeta : ScopedItemMeta<CompassMeta.Builder, CompassMeta>

Item metadata for a compass.

interface CrossbowMeta : ScopedItemMeta<CrossbowMeta.Builder, CrossbowMeta>

Item metadata for a crossbow.

FireworkRocketMeta

interface FireworkRocketMeta : ScopedItemMeta<FireworkRocketMeta.Builder, FireworkRocketMeta>

Item metadata for a firework rocket.

FireworkStarMeta

interface FireworkStarMeta : ScopedItemMeta<FireworkStarMeta.Builder, FireworkStarMeta>

Item metadata for a firework star.

interface ItemMeta

Holder for various item metadata values for an item stack.

ItemMetaBuilder

interface ItemMetaBuilder<B : ItemMetaBuilder<B, I>, I : ItemMeta>

The base builder for item metadata.

LeatherArmorMeta

interface LeatherArmorMeta : ScopedItemMeta<LeatherArmorMeta.Builder, LeatherArmorMeta>

Item metadata for leather armour.

interface PlayerHeadMeta : ScopedItemMeta<PlayerHeadMeta.Builder, PlayerHeadMeta>

Item metadata for a player head.

interface ScopedItemMeta<B : ItemMetaBuilder<B, I>, I : ItemMeta> : ItemMeta, ItemMetaBuilder.Provider<B>

An item meta subtype that changes all of the returns of functions in item meta to a generic type to avoid all subtypes having to override all of the functions.

WritableBookMeta

interface WritableBookMeta : BookMeta<WritableBookMeta.Builder, WritableBookMeta>

Item metadata for a writable book (book and quill).

WrittenBookMeta

interface WrittenBookMeta : BookMeta<WrittenBookMeta.Builder, WrittenBookMeta> , Book

Item metadata for books that have been written.

Functions

@Contract(value = "_ -> new", pure = true)

inline fun bundleMeta(builder: BundleMeta.Builder.() -> Unit): BundleMeta

Creates new bundle metadata from the result of applying the given builder function.

@Contract(value = "_ -> new", pure = true)

inline fun compassMeta(builder: CompassMeta.Builder.() -> Unit): CompassMeta

Creates new compass metadata from the result of applying the given builder function.

@Contract(value = "_ -> new", pure = true)

inline fun crossbowMeta(builder: CrossbowMeta.Builder.() -> Unit): CrossbowMeta

Creates new crossbow metadata from the result of applying the given builder function.

fireworkRocketMeta

@Contract(value = "_ -> new", pure = true)

inline fun fireworkRocketMeta(builder: FireworkRocketMeta.Builder.() -> Unit): FireworkRocketMeta

Creates new firework rocket metadata from the result of applying the given builder function.

fireworkStarMeta

@Contract(value = "_ -> new", pure = true)

inline fun fireworkStarMeta(builder: FireworkStarMeta.Builder.() -> Unit): FireworkStarMeta

Creates new firework star metadata from the result of applying the given builder function.

@JvmName(name = "itemMetaGeneric")

@Contract(value = "_ -> new", pure = true)

inline fun <B : ItemMetaBuilder<B, P>, P : ItemMetaBuilder.Provider<B>> itemMeta(builder: B.() -> Unit): P

Creates new item metadata of the given type P from the result of applying the given builder function to a new builder of type B.

@Contract(value = "_ -> new", pure = true)

inline fun itemMeta(builder: ItemMeta.Builder.() -> Unit): ItemMeta

Creates new item metadata from the result of applying the given builder function.

leatherArmorMeta

@Contract(value = "_ -> new", pure = true)

inline fun leatherArmorMeta(builder: LeatherArmorMeta.Builder.() -> Unit): LeatherArmorMeta

Creates new leather armour metadata from the result of applying the given builder function.

@Contract(value = "_ -> new", pure = true)

inline fun playerHeadMeta(builder: PlayerHeadMeta.Builder.() -> Unit): PlayerHeadMeta

Creates new player head metadata from the result of applying the given builder function.

writableBookMeta

@Contract(value = "_ -> new", pure = true)

inline fun writableBookMeta(builder: WritableBookMeta.Builder.() -> Unit): WritableBookMeta

Creates new writable book metadata from the result of applying the given builder function.

writtenBookMeta

@Contract(value = "_ -> new", pure = true)

inline fun writtenBookMeta(builder: WrittenBookMeta.Builder.() -> Unit): WrittenBookMeta

Creates new written book metadata from the result of applying the given builder function.