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<Holder<SoundEvent>>, particles: Provider<Boolean>) : ItemBehavior

Allows items to be consumed.

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<Holder<SoundEvent>>, particles: Provider<Boolean>)

Types

Companion

object Companion : ItemBehaviorFactory<Consumable>

Properties

animation

val animation: ItemUseAnimation

baseDataComponents

open override val baseDataComponents: Provider<DataComponentMap>

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

canAlwaysEat

val canAlwaysEat: Boolean

consumeTime

val consumeTime: Int

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.

nutrition

val nutrition: Int

particles

val particles: Boolean

possibleEffects

val possibleEffects: Map<PotionEffect, Float>

remains

val remains: ItemStack?

saturation

val saturation: Float

sound

val sound: Holder<SoundEvent>

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, 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)

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.