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

Consumable

class Consumable(nutrition: Provider<Int>, saturation: Provider<Float>, canAlwaysEat: Provider<Boolean>, consumeTime: Provider<Int>, remains: Provider<ItemStack?>, possibleEffects: Provider<Map<PotionEffect, Float>>, animation: Provider<ItemUseAnimation>, sound: Provider<Key>, particles: Provider<Boolean>) : ItemBehavior

Allows items to be consumed.

Parameters

nutrition

The nutrition that consuming the item provides.

saturation

The saturation that consuming the item provides.

canAlwaysEat

Whether the item can always be eaten, even if the player is not hungry.

consumeTime

The time it takes to consume the item in ticks.

remains

The item that remains after consuming the item.

possibleEffects

The possible effects that consuming the item can apply.

animation

The animation that is played when consuming the item.

sound

The sound that is played when consuming the item.

particles

Whether particles are spawned when consuming the item.

Constructors

Consumable

constructor(nutrition: Provider<Int>, saturation: Provider<Float>, canAlwaysEat: Provider<Boolean>, consumeTime: Provider<Int>, remains: Provider<ItemStack?>, possibleEffects: Provider<Map<PotionEffect, Float>>, animation: Provider<ItemUseAnimation>, sound: Provider<Key>, particles: Provider<Boolean>)

Properties

animation

val animation: ItemUseAnimation

The animation that is played when consuming the item.

baseDataComponents

open override val baseDataComponents: Provider<DataComponentMap>

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

canAlwaysEat

val canAlwaysEat: Boolean

Whether the item can always be eaten, even if the player is not hungry.

consumeTime

val consumeTime: Int

The time it takes to consume the item in ticks.

defaultCompound

open val defaultCompound: Provider<NamespacedCompound>

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

nutrition

val nutrition: Int

The nutrition that consuming the item provides.

particles

val particles: Boolean

Whether particles are spawned when consuming the item.

possibleEffects

val possibleEffects: Map<PotionEffect, Float>

The possible effects that consuming the item can apply.

remains

val remains: ItemStack?

The item that remains after consuming the item.

saturation

val saturation: Float

The saturation that consuming the item provides.

sound

val sound: Key

The sound that is played when consuming the item.

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.