nova/xyz.xenondevs.nova.world.item/NovaItem

NovaItem

class NovaItem

Represents a custom Nova item type.

Types

Companion

object Companion

Properties

baseDataComponents

val baseDataComponents: DataComponentMap

The base data components of this NovaItem.

behaviors

val behaviors: List<ItemBehavior>

The ItemBehaviors of this NovaItem.

block

val block: NovaBlock?

clientsideProvider

val clientsideProvider: ItemProvider

An ItemProvider containing the client-side ItemStack of this NovaItem, intended for use in Guis.

config

val config: Provider<CommentedConfigurationNode>

The configuration for this NovaItem. May be an empty node if the config file does not exist.

craftingRemainingItem

val craftingRemainingItem: ItemStack

The ItemStack that is left over after this NovaItem was used in a crafting recipe, or an empty stack if there is no remainder.

val id: Key

isHidden

val isHidden: Boolean

lore

val lore: List<Component>

maxStackSize

val maxStackSize: Int

name

val name: Component?

style

val style: Style

tooltipStyle

val tooltipStyle: TooltipStyle?

Functions

createClientsideItemBuilder

fun createClientsideItemBuilder(): ItemBuilder

Creates an ItemBuilder for an ItemStack of this NovaItem, in client-side format, intended for use in Guis.

createItemBuilder

fun createItemBuilder(): ItemBuilder

Creates an ItemBuilder for an ItemStack of this NovaItem, in server-side format.

createItemStack

fun createItemStack(amount: Int = 1): ItemStack

Creates an ItemStack of this NovaItem with the given amount in server-side format.

getBehavior

inline fun <T : Any> getBehavior(): T

Gets the first ItemBehavior that is an instance of T, or throws an IllegalStateException if there is none.

fun <T : Any> getBehavior(behavior: Class<T>): T

fun <T : Any> getBehavior(behavior: KClass<T>): T

Gets the first ItemBehavior that is an instance of behavior, or throws an IllegalStateException if there is none.

getBehaviorOrNull

inline fun <T : Any> getBehaviorOrNull(): T?

Gets the first ItemBehavior that is an instance of T, or null if there is none.

fun <T : Any> getBehaviorOrNull(type: Class<T>): T?

fun <T : Any> getBehaviorOrNull(type: KClass<T>): T?

Gets the first ItemBehavior that is an instance of type or a subclass, or null if there is none.

handleAttackEntity

fun handleAttackEntity(player: Player, itemStack: ItemStack, attacked: Entity, event: EntityDamageByEntityEvent)

Handles event where player attacks attacked using itemStack with this NovaItem in their main hand.

handleBlockBreakAction

fun handleBlockBreakAction(player: Player, itemStack: ItemStack, event: BlockBreakActionEvent)

Handles event where player performs a block break action using itemStack with this NovaItem.

handleBreak

fun handleBreak(player: Player, itemStack: ItemStack, event: PlayerItemBreakEvent)

Handles event where player breaks itemStack with this NovaItem.

handleBreakBlock

fun handleBreakBlock(player: Player, itemStack: ItemStack, event: BlockBreakEvent)

Handles event where player breaks a block using itemStack with this NovaItem.

handleConsume

fun handleConsume(player: Player, itemStack: ItemStack, event: PlayerItemConsumeEvent)

Handles event where player consumes itemStack with this NovaItem.

handleDamage

fun handleDamage(player: Player, itemStack: ItemStack, event: PlayerItemDamageEvent)

Handles event where player damages itemStack with this NovaItem.

handleEquip

fun handleEquip(player: Player, itemStack: ItemStack, slot: EquipmentSlot, equipped: Boolean, event: EntityEquipmentChangedEvent)

Handles event where player equips or unequips (equipped) itemStack with this NovaItem in slot.

handleEquipmentTick

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

Handles an equipment tick for player with itemStack with this NovaItem in slot.

handleInventoryClick

fun handleInventoryClick(player: Player, itemStack: ItemStack, event: InventoryClickEvent)

Handles event where player clicks on itemStack with this NovaItem in an inventory.

handleInventoryClickOnCursor

fun handleInventoryClickOnCursor(player: Player, itemStack: ItemStack, event: InventoryClickEvent)

Handles event where player clicks on a slot with itemStack with this NovaItem on their cursor.

handleInventoryHotbarSwap

fun handleInventoryHotbarSwap(player: Player, itemStack: ItemStack, event: InventoryClickEvent)

Handles event where player swaps itemStack with this NovaItem via hotbar swap.

handleInventoryTick

fun handleInventoryTick(player: Player, itemStack: ItemStack, slot: Int)

Handles an inventory tick for player with itemStack with this NovaItem in slot.

handleUseFinished

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

Handles the use of itemStack with this NovaItem finishing for entity in hand.

handleUseStopped

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

Handles the use of itemStack with this NovaItem being stopped for entity in hand and remainingUseTicks left.

handleUseTick

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

Handles a use tick for entity with itemStack with this NovaItem in hand with passedUseTicks passed and remainingUseTicks remaining.

hasBehavior

inline fun <T : Any> hasBehavior(): Boolean

Checks whether this NovaItem has an ItemBehavior of the reified type T, or a subclass of it.

fun <T : Any> hasBehavior(type: Class<T>): Boolean

fun <T : Any> hasBehavior(type: KClass<T>): Boolean

Checks whether this NovaItem has an ItemBehavior of the specified class type, or a subclass of it.

fun hasBehavior(behavior: ItemBehavior): Boolean

Checks whether this NovaItem has the specific behavior instance.

modifyBlockDamage

fun modifyBlockDamage(player: Player, itemStack: ItemStack, block: Block, damage: Double): Double

Modifies the block damage of this NovaItem when using itemStack to break block.

modifyClientSideItemType

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

Modifies the client-side item type of this NovaItem, in the context that it is sent to player and has server data.

modifyClientSideStack

fun modifyClientSideStack(player: Player?, server: ItemStack, client: ItemStack): ItemStack

Modifies the client-side stack of this NovaItem, in the context that it is sent to player and has data.

modifyUseDuration

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

Modifies the use duration of itemStack with this NovaItem for entity.

toString

open override fun toString(): String

use

fun use(ctx: Context<ItemUse>): InteractionResult

Handles using this NovaItem in the given ctx.

useOnBlock

fun useOnBlock(ctx: Context<BlockInteract>): InteractionResult

Handles using this NovaItem on a block in the given ctx.

useOnEntity

fun useOnEntity(ctx: Context<EntityInteract>): InteractionResult

Handles using this NovaItem on an entity in the given ctx.