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

Damageable

class Damageable(maxDurability: Provider<Int>, itemDamageOnAttackEntity: Provider<Int>, itemDamageOnBreakBlock: Provider<Int>, repairIngredient: Provider<RecipeChoice?>, breakSound: Provider<Key>) : ItemBehavior

Allows items to store and receive damage.

Parameters

maxDurability

The maximum durability of the item.

itemDamageOnAttackEntity

The amount of damage the item receives when attacking an entity.

itemDamageOnBreakBlock

The amount of damage the item receives when breaking a block.

repairIngredient

The ingredient required to repair the item in an anvil. Can be null for items that cannot be repaired.

breakSound

The sound that is played when the item breaks.

Constructors

Damageable

constructor(maxDurability: Provider<Int>, itemDamageOnAttackEntity: Provider<Int>, itemDamageOnBreakBlock: Provider<Int>, repairIngredient: Provider<RecipeChoice?>, breakSound: Provider<Key>)

Properties

baseDataComponents

open override val baseDataComponents: Provider<DataComponentMap>

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

breakSound

val breakSound: Sound?

The sound that is played when the item breaks.

breakSoundKey

val breakSoundKey: Key

The key of the sound that is played when the item breaks.

defaultCompound

open val defaultCompound: Provider<NamespacedCompound>

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

itemDamageOnAttackEntity

val itemDamageOnAttackEntity: Int

The amount of damage the item receives when attacking an entity.

itemDamageOnBreakBlock

val itemDamageOnBreakBlock: Int

The amount of damage the item receives when breaking a block.

maxDurability

val maxDurability: Int

The maximum durability of the item.

repairIngredient

val repairIngredient: RecipeChoice?

The ingredient required to repair the item in an anvil.

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)

handleConsume

open fun handleConsume(player: Player, itemStack: ItemStack, event: PlayerItemConsumeEvent)

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, slot: EquipmentSlot, equipped: Boolean, event: EntityEquipmentChangedEvent)

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)

handleInventoryTick

open fun handleInventoryTick(player: Player, itemStack: ItemStack, slot: Int)

handleRelease

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

modifyBlockDamage

open fun modifyBlockDamage(player: Player, itemStack: ItemStack, block: Block, 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.