api/org.kryptonmc.api.item/ItemStack

ItemStack

interface ItemStack : Buildable<ItemStack, ItemStack.Builder> , HoverEventSource<HoverEvent.ShowItem>

A stack of items in an inventory.

Types

Builder

interface Builder : Buildable.Builder<ItemStack>

For building new ItemStacks.

Companion

object Companion

Factory

@ApiStatus.Internal

interface Factory

Functions

asHoverEvent

@NotNull

open fun asHoverEvent(): @NotNull HoverEvent<HoverEvent.ShowItem>

@NotNull

abstract fun asHoverEvent(@NotNull op: @NotNull UnaryOperator<HoverEvent.ShowItem>): @NotNull HoverEvent<HoverEvent.ShowItem>

grow

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

open fun grow(amount: Int): ItemStack

Grows the amount of this item stack by the given amount and returns the resulting item stack.

meta

inline fun ItemStack.meta(): I?

Gets the metadata for this item stack as the given type I, or returns null if the metadata could not be casted to the given type I.

shrink

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

open fun shrink(amount: Int): ItemStack

Shrinks the amount of this item stack by the given amount and returns the resulting item stack.

toBuilder

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

@NotNull

abstract fun toBuilder(): @NotNull ItemStack.Builder

withAmount

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

abstract fun withAmount(amount: Int): ItemStack

Creates a new item stack with the given amount.

withMeta

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

open fun withMeta(builder: Consumer<ItemMeta.Builder>): ItemStack

Creates a new item stack with meta retrieved applying the given builder to a new item metadata builder.

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

abstract fun withMeta(meta: ItemMeta): ItemStack

Creates a new item stack with the given meta.

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

open fun , P : ItemMetaBuilder.Provider, ItemMeta> withMeta(type: Class, builder: Consumer): ItemStack

Creates a new item stack with meta retrieved applying the given builder to a new meta builder created with the given type.

withMeta

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

@JvmName(name = "withMetaGeneric")

inline fun , P : IMP, ItemMeta> ItemStack.withMeta(builder: B.() -> Unit): ItemStack

Creates a new item stack with meta retrieved applying the given builder to a new meta builder created with the given type P.

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

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

Creates a new item stack with meta retrieved applying the given builder to a new item metadata builder.

withType

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

abstract fun withType(type: ItemType): ItemStack

Creates a new item stack with the given type.

Properties

amount

@get:JvmName(name = "amount")

abstract val amount: Int

The amount of items in this stack.