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

Crossbow

class Crossbow(logic: CrossbowLogic = CrossbowLogic.Vanilla, customModelDataOffset: Int = 0) : ItemBehavior

Makes items behave like crossbows, with customizable logic.

Example item model definition:

modelDefinition {
    model = select(SelectItemModelProperty.ChargedType) {
        case[ChargedType.ARROW] = buildModel { getModel("minecraft:item/crossbow_arrow") }
        case[ChargedType.ROCKET] = buildModel { getModel("minecraft:item/crossbow_firework") }
        fallback = condition(ConditionItemModelProperty.UsingItem) {
            onTrue = rangeDispatch(RangeDispatchItemModelProperty.CrossbowPull) {
                fallback = buildModel { getModel("minecraft:item/crossbow_pulling_0") }
                entry[0.58] = buildModel { getModel("minecraft:item/crossbow_pulling_1") }
                entry[1.0] = buildModel { getModel("minecraft:item/crossbow_pulling_2") }
            }
            onFalse = buildModel { getModel("minecraft:item/crossbow") }
        }
    }
}

In item model definitions, ChargedType can only differentiate between rockets and arrows, where ChargedType.ARROW is used for any non-rocket projectile. However, ChargedProjectiles allows loading any item type into the crossbow. To address this inconsistency, this behavior writes the item ids of all charged projectiles into the item's client-side custom model data, starting at index customModelDataOffset.

Example item model definition using custom model data (with no offset):

modelDefinition {
    model = select(SelectItemModelProperty.CustomModelData) {
        case["minecraft:arrow"] = buildModel { getModel("minecraft:item/crossbow_arrow") }
        // ... all other arrow types
        case["minecraft:firework_rocket"] = buildModel { getModel("minecraft:item/crossbow_firework") }

        fallback = condition(ConditionItemModelProperty.UsingItem) {
            onTrue = rangeDispatch(RangeDispatchItemModelProperty.CrossbowPull) {
                fallback = buildModel { getModel("minecraft:item/crossbow_pulling_0") }
                entry[0.58] = buildModel { getModel("minecraft:item/crossbow_pulling_1") }
                entry[1.0] = buildModel { getModel("minecraft:item/crossbow_pulling_2") }
            }
            onFalse = buildModel { getModel("minecraft:item/crossbow") }
        }
    }
}

Constructors

Crossbow

constructor(logic: CrossbowLogic = CrossbowLogic.Vanilla, customModelDataOffset: Int = 0)

Properties

baseDataComponents

open override val baseDataComponents: Provider<DataComponentMap>

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

defaultCompound

open val defaultCompound: Provider<NamespacedCompound>

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

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.

handleEquipmentTick

open override fun handleEquipmentTick(player: Player, itemStack: ItemStack, slot: EquipmentSlot)

Called every tick for an itemStack with this behavior that is equipped by player in the given slot.

handleInteract

open override 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.

handleUseFinished

open fun handleUseFinished(entity: LivingEntity, itemStack: ItemStack, hand: EquipmentSlot)

Called when entity finishes using an itemStack with this behavior in hand.

handleUseStopped

open fun handleUseStopped(entity: LivingEntity, itemStack: ItemStack, hand: EquipmentSlot, remainingUseTicks: Int)

Called when entity stops using an itemStack with this behavior in hand, with remainingUseTicks left.

handleUseTick

open override fun handleUseTick(entity: LivingEntity, itemStack: ItemStack, hand: EquipmentSlot, remainingUseTicks: Int)

Called every tick while an itemStack with this behavior is being used by entity in hand, with remainingUseTicks left.

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.

modifyClientSideItemType

open override fun modifyClientSideItemType(player: Player?, server: ItemStack, client: Material): Material

Updates the client-side item type for client-side item stacks to be viewed by player in place of the server-side item stack. This is called before modifyClientSideStack and influences the generation of the client-side ItemStack's patch. Called off-main thread.

modifyClientSideStack

open override 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. Called off-main thread.

modifyUseDuration

open override fun modifyUseDuration(entity: LivingEntity, itemStack: ItemStack, duration: Int): Int

Modifies the server-side use duration of itemStack with this behavior for entity. The initial value of duration may stem from baseDataComponents. If the use duration is <= 0, the item cannot be used (no right click and hold action).

modifyUseRemainder

open fun modifyUseRemainder(entity: LivingEntity, original: ItemStack, hand: EquipmentSlot, remainder: ItemStack): ItemStack

Modifies the remainder when entity finishes using original with this behavior in hand.

toString

open fun toString(itemStack: ItemStack): String

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