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

Tool

class Tool(tier: Provider<ToolTier>, categories: Provider<Set<ToolCategory>>, breakSpeed: Provider<Double>, attackDamage: Provider<Double?>, attackSpeed: Provider<Double?>, knockbackBonus: Provider<Int>, canSweepAttack: Provider<Boolean>, canBreakBlocksInCreative: Provider<Boolean>, disableBlocking: Provider<Int>) : ItemBehavior

Allows items to be used as tools, by specifying break and attack properties.

Parameters

tier

The ToolTier of the tool.

categories

The ToolCategory ToolCategories of the tool.

breakSpeed

The break speed of the tool.

attackDamage

The attack damage of the tool.

attackSpeed

The attack speed of the tool.

knockbackBonus

The knockback bonus of the tool when attacking.

canSweepAttack

Whether the tool can perform a sweep attack.

canBreakBlocksInCreative

Whether the tool can break blocks in creative mode.

disableBlocking

The amount of ticks to disable an attacked shield's blocking status for when attacking with this tool.

Constructors

Link copied to clipboard
constructor(tier: Provider<ToolTier>, categories: Provider<Set<ToolCategory>>, breakSpeed: Provider<Double>, attackDamage: Provider<Double?>, attackSpeed: Provider<Double?>, knockbackBonus: Provider<Int>, canSweepAttack: Provider<Boolean>, canBreakBlocksInCreative: Provider<Boolean>, disableBlocking: Provider<Int>)

Properties

Link copied to clipboard
val attackDamage: Double?

The attack damage of this tool.

Link copied to clipboard
val attackSpeed: Double?

The attack speed of this tool.

Link copied to clipboard
open override val baseDataComponents: Provider<DataComponentMap>

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

Link copied to clipboard
val breakSpeed: Double

The break speed of this tool.

Link copied to clipboard
val canBreakBlocksInCreative: Boolean

Whether this tool can break blocks in creative mode.

Link copied to clipboard
val canSweepAttack: Boolean

Whether this tool can perform a sweep attack.

Link copied to clipboard
val categories: Set<ToolCategory>

The ToolCategory ToolCategories of this tool.

Link copied to clipboard
open val defaultCompound: Provider<NamespacedCompound>

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

Link copied to clipboard
val disableBlocking: Int

The amount of ticks to disable blocking for when using this tool.

Link copied to clipboard
val knockbackBonus: Int

The knockback bonus of this tool when attacking.

Link copied to clipboard
val tier: ToolTier

The ToolTier of this tool.

Link copied to clipboard
open val vanillaMaterialProperties: Provider<List<VanillaMaterialProperty>>

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

Functions

Link copied to clipboard
open fun handleAttackEntity(player: Player, itemStack: ItemStack, attacked: Entity, event: EntityDamageByEntityEvent)
Link copied to clipboard
open fun handleBlockBreakAction(player: Player, itemStack: ItemStack, event: BlockBreakActionEvent)
Link copied to clipboard
open fun handleBreak(player: Player, itemStack: ItemStack, event: PlayerItemBreakEvent)
Link copied to clipboard
open fun handleBreakBlock(player: Player, itemStack: ItemStack, event: BlockBreakEvent)
Link copied to clipboard
open fun handleConsume(player: Player, itemStack: ItemStack, event: PlayerItemConsumeEvent)
Link copied to clipboard
open fun handleDamage(player: Player, itemStack: ItemStack, event: PlayerItemDamageEvent)
Link copied to clipboard
open fun handleEntityInteract(player: Player, itemStack: ItemStack, clicked: Entity, event: PlayerInteractAtEntityEvent)
Link copied to clipboard
open fun handleEquip(player: Player, itemStack: ItemStack, slot: EquipmentSlot, equipped: Boolean, event: EntityEquipmentChangedEvent)
Link copied to clipboard
open fun handleInteract(player: Player, itemStack: ItemStack, action: Action, wrappedEvent: WrappedPlayerInteractEvent)
Link copied to clipboard
open fun handleInventoryClick(player: Player, itemStack: ItemStack, event: InventoryClickEvent)
Link copied to clipboard
open fun handleInventoryClickOnCursor(player: Player, itemStack: ItemStack, event: InventoryClickEvent)
Link copied to clipboard
open fun handleInventoryHotbarSwap(player: Player, itemStack: ItemStack, event: InventoryClickEvent)
Link copied to clipboard
open fun handleInventoryTick(player: Player, itemStack: ItemStack, slot: Int)
Link copied to clipboard
open fun handleRelease(player: Player, itemStack: ItemStack, event: ServerboundPlayerActionPacketEvent)
Link copied to clipboard
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.

Link copied to clipboard
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.

Link copied to clipboard
open override fun toString(itemStack: ItemStack): String

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