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

Equippable

class Equippable(equipment: Provider<Equipment?>, slot: Provider<EquipmentSlot>, armor: Provider<Double>, armorToughness: Provider<Double>, knockbackResistance: Provider<Double>, equipSound: Provider<Key>, allowedEntities: Provider<RegistryKeySet<EntityType>?>, dispensable: Provider<Boolean>, swappable: Provider<Boolean>, damageOnHurt: Provider<Boolean>, equipOnInteract: Provider<Boolean>, canBeSheared: Provider<Boolean>, shearingSound: Provider<Key>) : ItemBehavior

Allows items to be worn in armor slots.

Parameters

equipment

The equipment texture to use, or null for no texture.

slot

The slot in which the item can be worn.

armor

The amount of armor this item provides.

armorToughness

The amount of armor toughness this item provides.

knockbackResistance

The amount of knockback resistance this item provides.

equipSound

The sound that is played when the item is equipped.

allowedEntities

The entity types that are allowed to wear this item, or null for all entities.

dispensable

Whether this item can be dispensed from a dispenser.

swappable

Whether this item can be swapped with other items in the same slot.

damageOnHurt

Whether this item will be damaged when the wearing entity is damaged.

equipOnInteract

Whether this item should be equipped when right-clicking.

canBeSheared

Whether players can use shears to remove this equippable item from a wearing entity.

shearingSound

The sound that is played when the equippable is removed by shears.

Constructors

Equippable

constructor(equipment: Provider<Equipment?>, slot: Provider<EquipmentSlot>, armor: Provider<Double>, armorToughness: Provider<Double>, knockbackResistance: Provider<Double>, equipSound: Provider<Key>, allowedEntities: Provider<RegistryKeySet<EntityType>?>, dispensable: Provider<Boolean>, swappable: Provider<Boolean>, damageOnHurt: Provider<Boolean>, equipOnInteract: Provider<Boolean>, canBeSheared: Provider<Boolean>, shearingSound: Provider<Key>)

Properties

allowedEntities

val allowedEntities: Set<EntityType?>?

The entity types that are allowed to wear this item.

allowedEntityKeys

val allowedEntityKeys: RegistryKeySet<EntityType>?

The ids of the entities that are allowed to wear this item.

armor

val armor: Double

The amount of armor this item provides.

armorToughness

val armorToughness: Double

The amount of armor toughness this item provides.

baseDataComponents

open override val baseDataComponents: Provider<DataComponentMap>

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

canBeSheared

val canBeSheared: Boolean

Whether players can use shears to remove this equippable item from a wearing entity.

damageOnHurt

val damageOnHurt: Boolean

Whether this item will be damaged when the wearing entity is damaged.

defaultCompound

open val defaultCompound: Provider<NamespacedCompound>

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

dispensable

val dispensable: Boolean

Whether this item can be dispensed from a dispenser.

equipOnInteract

val equipOnInteract: Boolean

Whether this item should be equipped when right-clicking.

equipSound

val equipSound: Sound?

The sound that is played when the item is equipped.

equipSoundKey

val equipSoundKey: Key

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

knockbackResistance

val knockbackResistance: Double

The amount of knockback resistance this item provides.

shearingSound

val shearingSound: Sound?

The sound that is played when the equippable is removed by shears.

shearingSoundKey

val shearingSoundKey: Key

The sound that is played when the equippable is removed by shears.

slot

val slot: EquipmentSlot

The slot in which the item can be worn.

swappable

val swappable: Boolean

Whether this item can be swapped with other items in the same slot.

texture

val texture: Equipment?

The custom armor texture, or null if no custom texture should be used.

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)

Called when an EntityDamageByEntityEvent is fired where player attacks attacked using itemStack with this behavior in their main hand.

handleBlockBreakAction

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

Called when a BlockBreakActionEvent is fired where player breaks a block with an itemStack with this behavior.

handleBreak

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

Called when a aPlayerItemBreakEvent is fired where an itemStack with this behavior runs out of durability and breaks.

handleBreakBlock

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

Called when a BlockBreakEvent is fired where player uses an itemStack with this behavior.

handleConsume

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

Called when a PlayerItemConsumeEvent is fired where player consumes an itemStack with this behavior.

handleDamage

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

Called when a PlayerItemDamageEvent is fired where an itemStack with this behavior takes damage.

handleEntityInteract

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

Called when a PlayerInteractAtEntityEvent is fired for an itemStack with this behavior.

handleEquip

open fun handleEquip(player: Player, itemStack: ItemStack, slot: EquipmentSlot, equipped: Boolean, event: EntityEquipmentChangedEvent)

Called when a EntityEquipmentChangedEvent is fired where player equips or unequips an itemStack with this behavior.

handleInteract

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

Called when a PlayerInteractEvent is fired for an itemStack with this behavior.

handleInventoryClick

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

Called when an InventoryClickEvent is fired where player clicks on an itemStack with this behavior.

handleInventoryClickOnCursor

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

Called when an InventoryClickEvent is fired where player clicks on an itemStack with this behavior in their cursor.

handleInventoryHotbarSwap

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

Called when an InventoryClickEvent is fired where player swaps an item with a hotbar itemStack with this behavior.

handleInventoryTick

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

Called every tick for an itemStack with this behavior that is in the player's inventory. The slot is the index inside the player inventory's contents.

handleRelease

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

Called when a ServerboundPlayerActionPacketEvent is fired where the server receives a player action packet regarding an itemStack with this behavior. Note that this is a packet event, and as such this function is called a netty thread, not the server thread.

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?, server: ItemStack, client: ItemStack): ItemStack

Updates the client-side item stack that is to be viewed by player in place of the server-side item stack.

toString

open override fun toString(itemStack: ItemStack): String

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