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

Shield

class Shield(blockDelay: Provider<Int>, disableCooldownScale: Provider<Double>, bypassedBy: Provider<TagKey<DamageType>?>, blockSound: Provider<Key?>, disableSound: Provider<Key?>) : ItemBehavior

Parameters

blockDelay

The number of ticks that right-click must be held before successfully blocking attacks.

disableCooldownScale

A multiplier that is applied to the number of ticks that the item will be on cooldown for when attacked by a disabling attack.

bypassedBy

A damage type tag containing the damage types that bypass the shield. Can be null if no damage types bypass the shield.

blockSound

The sound that is played when the shield successfully blocks an attack. Can be null if no sound should be played.

disableSound

The sound that is played when the shield is disabled by a disabling attack. Can be null if no sound should be played.

Constructors

Shield

constructor(blockDelay: Provider<Int>, disableCooldownScale: Provider<Double>, bypassedBy: Provider<TagKey<DamageType>?>, blockSound: Provider<Key?>, disableSound: Provider<Key?>)

Properties

baseDataComponents

open override val baseDataComponents: Provider<DataComponentMap>

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

blockDelay

val blockDelay: Int

The number of ticks that right-click must be held before successfully blocking attacks.

blockSound

val blockSound: Sound?

The sound that is played when the shield successfully blocks an attack.

blockSoundKey

val blockSoundKey: Key?

The key of the sound that is played when the shield successfully blocks an attack.

bypassedBy

val bypassedBy: TagKey<DamageType>?

A damage type tag containing the damage types that bypass the shield.

defaultCompound

open val defaultCompound: Provider<NamespacedCompound>

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

disableCooldownScale

val disableCooldownScale: Double

A multiplier that is applied to the number of ticks that the item will be on cooldown for when attacked by a disabling attack.

disableSound

val disableSound: Sound?

The sound that is played when the shield is disabled by a disabling attack.

disableSoundKey

val disableSoundKey: Key?

The key of the sound that is played when the shield is disabled by a disabling attack.

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.