nova/xyz.xenondevs.nova.world.item.behavior/Enchantable

Enchantable

class Enchantable(enchantmentValue: Provider<Int>, primaryEnchantments: Provider<Set<Enchantment>>, supportedEnchantments: Provider<Set<Enchantment>>) : ItemBehavior

Makes an item enchantable.

Parameters

enchantmentValue

The enchantment value of the item. A higher enchantment value brings more secondary and higher-level enchantments in the enchanting table. Vanilla enchantment values: wood: 15, stone: 5, iron: 14, diamond: 10, gold: 22, netherite: 15

primaryEnchantments

The enchantments that appear in the enchanting table.

supportedEnchantments

The enchantments that can be applied to the item, i.e. via an anvil or commands.

Constructors

Enchantable

constructor(enchantmentValue: Provider<Int>, primaryEnchantments: Provider<Set<Enchantment>>, supportedEnchantments: Provider<Set<Enchantment>>)

Types

Companion

object Companion : ItemBehaviorFactory<Enchantable>

Properties

baseDataComponents

open override val baseDataComponents: Provider<DataComponentMap>

The base data components that every item with this ItemBehavior has.

defaultCompound

open val defaultCompound: Provider<NamespacedCompound>

The NamespacedCompound that every new ItemStack of an item with this ItemBehavior has by default.

defaultPatch

open val defaultPatch: Provider<DataComponentPatch>

The data component patch that every new ItemStack of an item with this ItemBehavior has by default.

enchantmentValue

val enchantmentValue: Int

primaryEnchantments

val primaryEnchantments: Set<Enchantment>

The enchantments that appear in the enchanting table.

supportedEnchantments

val supportedEnchantments: Set<Enchantment>

The enchantments that can be applied to the item, i.e. via an anvil or commands.

vanillaMaterialProperties

open val vanillaMaterialProperties: Provider<List<VanillaMaterialProperty>>

The vanilla material properties that an item with this ItemBehavior requires.

Functions

handleAttackEntity

open fun handleAttackEntity(player: Player, itemStack: ItemStack, attacked: Entity, event: EntityDamageByEntityEvent)

handleBlockBreakAction

open fun handleBlockBreakAction(player: Player, itemStack: ItemStack, event: BlockBreakActionEvent)

handleBreak

open fun handleBreak(player: Player, itemStack: ItemStack, event: PlayerItemBreakEvent)

handleBreakBlock

open fun handleBreakBlock(player: Player, itemStack: ItemStack, event: BlockBreakEvent)

handleDamage

open fun handleDamage(player: Player, itemStack: ItemStack, event: PlayerItemDamageEvent)

handleEntityInteract

open fun handleEntityInteract(player: Player, itemStack: ItemStack, clicked: Entity, event: PlayerInteractAtEntityEvent)

handleEquip

open fun handleEquip(player: Player, itemStack: ItemStack, equipped: Boolean, event: ArmorEquipEvent)

handleInteract

open fun handleInteract(player: Player, itemStack: ItemStack, action: Action, wrappedEvent: WrappedPlayerInteractEvent)

handleInventoryClick

open fun handleInventoryClick(player: Player, itemStack: ItemStack, event: InventoryClickEvent)

handleInventoryClickOnCursor

open fun handleInventoryClickOnCursor(player: Player, itemStack: ItemStack, event: InventoryClickEvent)

handleInventoryHotbarSwap

open fun handleInventoryHotbarSwap(player: Player, itemStack: ItemStack, event: InventoryClickEvent)

handleRelease

open fun handleRelease(player: Player, itemStack: ItemStack, event: ServerboundPlayerActionPacketEvent)

modifyBlockDamage

open fun modifyBlockDamage(player: Player, itemStack: ItemStack, damage: Double): Double

Modifies the damage when player is breaking a block with itemStack. This damage is applied to the block every tick until 1.0 is reached, at which point the block is destroyed.

modifyClientSideStack

open fun modifyClientSideStack(player: Player?, itemStack: ItemStack, data: NamespacedCompound): ItemStack

Updates the client-side itemStack that is to be viewed by player and has server-side data.

toString

open override fun toString(itemStack: ItemStack): String

Creates a string representation of this ItemBehavior and its data in itemStack.