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

Shield

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

Makes items act like shields.

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.

damageReductions

A list of DamageReductions of how much damage should be blocked on attack.

itemDamage

Specifies how much damage is applied to the item when it blocks an 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>, damageReductions: Provider<List<DamageReduction>>, itemDamage: Provider<ItemDamageFunction>, 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.

damageReductions

val damageReductions: List<DamageReduction>

A list of DamageReductions of how much damage should be blocked on attack.

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.

itemDamage

val itemDamage: ItemDamageFunction

Specifies how much damage is applied to the item when it blocks an 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)

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.