KIA/de.staticred.kia.inventory.item/RegisteredKItemImpl

RegisteredKItemImpl

class RegisteredKItemImpl(var draggingMode: DraggingMode, val material: Material, amount: Int) : KItemImpl, RegisteredKItem

Example impl of RegisteredKItem

Constructors

RegisteredKItemImpl

constructor(draggingMode: DraggingMode, material: Material, amount: Int)

Types

Companion

object Companion

Properties

clickableInAnimation

open override var clickableInAnimation: Boolean

Whether the item can be clicked while inside an animation or not

draggingMode

open override var draggingMode: DraggingMode

Determines the behaviour of the item when being dragged around the inventory

open override var id: UUID

The unique ID of this identifiable

material

val material: Material

of the item

model

open override var model: Key?

The custom model of this item

parent

open override var parent: AbstractContentContainer?

The parent inventory, the item is inside of

slot

open override var slot: Int

Slot of the item in the parent inventory, if the parent inventory is set

Functions

add

@NotNull

open fun add(): @NotNull ItemStack

@NotNull

open fun add(p0: Int): @NotNull ItemStack

addBehavior

open override fun addBehavior(kItemBehavior: KItemBehavior): KItemBehavior

Adds a behavior to the item.

open override fun addBehavior(identifier: KIdentifier, block: ItemStack.(context: KItemBehaviorContext) -> Unit): KItemBehavior

Adds a behavior to the item with a specific identifier and functionality block.

addEnchantment

open fun addEnchantment(@NotNull p0: @NotNull Enchantment, p1: Int)

addEnchantments

open fun addEnchantments(@NotNull p0: @NotNull MutableMap<Enchantment, Int>)

addItemFlags

open fun addItemFlags(@NotNull vararg p0: @NotNull ItemFlag)

addUnsafeEnchantment

open fun addUnsafeEnchantment(@NotNull p0: @NotNull Enchantment, p1: Int)

addUnsafeEnchantments

open fun addUnsafeEnchantments(@NotNull p0: @NotNull MutableMap<Enchantment, Int>)

asHoverEvent

@NotNull

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

@NotNull

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

asOne

@NotNull

open fun asOne(): @NotNull ItemStack

asQuantity

@NotNull

open fun asQuantity(p0: Int): @NotNull ItemStack

canRepair

open fun canRepair(@NotNull p0: @NotNull ItemStack): Boolean

clicked

open override fun clicked(player: Player, kInventory: KInventory)

The item has been clicked by a player inside an inventory

clone

@NotNull

open override fun clone(): @NotNull ItemStack

computeTooltipLines

open fun computeTooltipLines(@NotNull p0: @NotNull TooltipContext, @Nullable p1: @Nullable Player?): @NotNull @Unmodifiable MutableList<Component>

containsEnchantment

open fun containsEnchantment(@NotNull p0: @NotNull Enchantment): Boolean

copyDataFrom

@ApiStatus.Experimental

open fun copyDataFrom(@NotNull p0: @NotNull ItemStack, @NotNull p1: @NotNull Predicate<@NotNull DataComponentType>)

damage

@NotNull

open fun damage(p0: Int, @NotNull p1: @NotNull LivingEntity): @NotNull ItemStack

displayName

open fun displayName(): @NotNull Component

draggable

open override fun draggable(): Boolean

editMeta

open fun editMeta(@NotNull p0: @NotNull Consumer<in ItemMeta>): Boolean

open fun <M : ItemMeta> editMeta(@NotNull p0: @NotNull Class<M>, @NotNull p1: @NotNull Consumer<in M>): Boolean

editPersistentDataContainer

open fun editPersistentDataContainer(@NotNull p0: @NotNull Consumer<PersistentDataContainer>): Boolean

effectiveName

@NotNull

open fun effectiveName(): @NotNull Component

enchant

open override fun enchant(enchantment: Enchantment, level: Int)

Enchants this item with the given parameters

enchantWithLevels

@NotNull

open fun enchantWithLevels(p0: Int, @NotNull p1: @NotNull RegistryKeySet<@NotNull Enchantment>, @NotNull p2: @NotNull Random): @NotNull ItemStack

@NotNull

open fun enchantWithLevels(p0: Int, p1: Boolean, @NotNull p2: @NotNull Random): @NotNull ItemStack

ensureServerConversions

@NotNull

open fun ensureServerConversions(): @NotNull ItemStack

equals

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

getAmount

open fun getAmount(): Int

getData

@Nullable

open fun ~~getData~~(): @Nullable MaterialData?

@Contract(pure = true)

@ApiStatus.Experimental

@Nullable

open override fun <T : Any> getData(p0: @NotNull DataComponentType.Valued<T>): @Nullable T?

getDataOrDefault

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

@ApiStatus.Experimental

@Nullable

open override fun <T : Any> getDataOrDefault(p0: @NotNull DataComponentType.Valued<out T>, @Nullable p1: @Nullable T?): @Nullable T?

getDataTypes

@Contract(value = "-> new")

@ApiStatus.Experimental

open fun getDataTypes(): @Unmodifiable MutableSet<@NotNull DataComponentType>

getDurability

open fun ~~getDurability~~(): Short

getEnchantmentLevel

open fun getEnchantmentLevel(@NotNull p0: @NotNull Enchantment): Int

getEnchantments

@NotNull

open fun getEnchantments(): @NotNull MutableMap<Enchantment, Int>

getI18NDisplayName

@Nullable

open fun ~~getI18NDisplayName~~(): @Nullable String?

getItemFlags

@NotNull

open fun getItemFlags(): @NotNull MutableSet<ItemFlag>

getItemMeta

@UndefinedNullability

open fun getItemMeta(): ItemMeta

getLore

@Nullable

open fun ~~getLore~~(): @Nullable MutableList<String>?

getMaxItemUseDuration

open fun ~~getMaxItemUseDuration~~(): Int

open fun getMaxItemUseDuration(@NotNull p0: @NotNull LivingEntity): Int

getMaxStackSize

open fun getMaxStackSize(): Int

getPersistentDataContainer

open override fun getPersistentDataContainer(): @NotNull PersistentDataContainerView

getRarity

@NotNull

open fun ~~getRarity~~(): @NotNull ItemRarity

getTranslationKey

@NotNull

open override fun ~~getTranslationKey~~(): @NotNull String

getType

@NotNull

open fun getType(): @NotNull Material

hasData

@Contract(pure = true)

@ApiStatus.Experimental

open override fun hasData(p0: @NotNull DataComponentType): Boolean

hashCode

open override fun hashCode(): Int

hasID

open override fun hasID(): Boolean

hasItemFlag

open fun hasItemFlag(@NotNull p0: @NotNull ItemFlag): Boolean

hasItemMeta

open fun hasItemMeta(): Boolean

isDataOverridden

@ApiStatus.Experimental

open fun isDataOverridden(p0: @NotNull DataComponentType): Boolean

isEmpty

open fun isEmpty(): Boolean

isRepairableBy

open fun isRepairableBy(@NotNull p0: @NotNull ItemStack): Boolean

isSimilar

open fun isSimilar(@Nullable p0: @Nullable ItemStack?): Boolean

leftClicked

open override fun leftClicked(player: Player, event: PlayerInteractEvent)

When the item has been left-clicked by a player

lore

@Nullable

open fun lore(): @Nullable MutableList<Component>?

open fun lore(@Nullable p0: @Nullable MutableList<out Component>?)

matchesWithoutData

@ApiStatus.Experimental

open fun matchesWithoutData(@NotNull p0: @NotNull ItemStack, @NotNull p1: @NotNull MutableSet<@NotNull DataComponentType>): Boolean

@ApiStatus.Experimental

open fun matchesWithoutData(@NotNull p0: @NotNull ItemStack, @NotNull p1: @NotNull MutableSet<@NotNull DataComponentType>, p2: Boolean): Boolean

onClick

open override fun onClick(action: KInventory.(RegisteredKItem, Player) -> Unit)

Executed when the item is valid clicked in an inventory

onLeftClick

open override fun onLeftClick(action: RegisteredKItem.(Player, PlayerInteractEvent) -> Unit)

Executed when the player left-clicked with this item outside an inventory

onRightClick

open override fun onRightClick(action: RegisteredKItem.(Player, PlayerInteractEvent) -> Unit)

Executed when the player right-clicked with this item outside an inventory

removeEnchantment

open fun removeEnchantment(@NotNull p0: @NotNull Enchantment): Int

removeEnchantments

open fun removeEnchantments()

removeItemFlags

open fun removeItemFlags(@NotNull vararg p0: @NotNull ItemFlag)

resetData

@ApiStatus.Experimental

open fun resetData(p0: @NotNull DataComponentType)

rightClicked

open override fun rightClicked(player: Player, event: PlayerInteractEvent)

When the item has been right-clicked by a player

serialize

@NotNull

open override fun serialize(): @NotNull MutableMap<String, Any>

serializeAsBytes

open fun serializeAsBytes(): @NotNull ByteArray

setAmount

open fun setAmount(p0: Int)

setData

@ApiStatus.Experimental

open override fun setData(p0: @NotNull DataComponentType.NonValued)

open fun ~~setData~~(@Nullable p0: @Nullable MaterialData?)

@ApiStatus.Experimental

open override fun <T : Any> setData(p0: @NotNull DataComponentType.Valued<T>, @NotNull p1: @NotNull T & Any)

@ApiStatus.Experimental

open override fun <T : Any> setData(p0: @NotNull DataComponentType.Valued<T>, @NotNull p1: @NotNull DataComponentBuilder<T>)

setDisplayName

open override fun setDisplayName(name: Component)

Sets the display name of the item

setDurability

open fun ~~setDurability~~(p0: Short)

setItemLore

open override fun setItemLore(lore: List<Component>)

Sets the lore of the item

setItemMeta

open fun setItemMeta(@Nullable p0: @Nullable ItemMeta?): Boolean

setLore

open fun ~~setLore~~(@Nullable p0: @Nullable MutableList<String>?)

setType

open fun ~~setType~~(@NotNull p0: @NotNull Material)

subtract

@NotNull

open fun subtract(): @NotNull ItemStack

@NotNull

open fun subtract(p0: Int): @NotNull ItemStack

toItemStack

open override fun toItemStack(): ItemStack

Transforms the KItem to a Bukkit ItemStack

toString

open override fun toString(): String

translationKey

@NotNull

open override fun translationKey(): @NotNull String

unsetData

@ApiStatus.Experimental

open fun unsetData(p0: @NotNull DataComponentType)

withType

@NotNull

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

open fun withType(@NotNull p0: @NotNull Material): @NotNull ItemStack