Staff Mod/opekope2.avm_staff.api.item/StaffItem

StaffItem

abstract class StaffItem(settings: Item.Settings) : Item(source)

Staff item dispatching functionality to StaffHandler without loader specific functionality. Implementing loader-specific interfaces is highly recommended when extending the class to pass loader-specific functionality to StaffHandler.

Constructors

StaffItem

constructor(settings: Item.Settings)

Inherited properties

components

val components: ComponentMap

hasStaffHandler

@get:JvmName(name = "hasStaffHandler")

val Item.hasStaffHandler: Boolean

Returns if the given item has a registered handler when inserted into a staff.

recipeRemainder

@Nullable

@get:Nullable

val recipeRemainder: Item?

registryEntry

val registryEntry: RegistryEntry.Reference<Item>

requiredFeatures

val requiredFeatures: FeatureSet

staffHandler

val Item.staffHandler: StaffHandler?

Returns the registered staff handler of the given item if available.

staffHandlerOrDefault

val Item?.staffHandlerOrDefault: StaffHandler

Returns the registered staff handler of the given item if available, StaffHandler.Default otherwise.

Functions

attack

open fun attack(staffStack: ItemStack, world: World, attacker: LivingEntity, hand: Hand)

attackBlock

open fun attackBlock(staffStack: ItemStack, world: World, attacker: LivingEntity, target: BlockPos, side: Direction, hand: Hand): ActionResult

attackEntity

open fun attackEntity(staffStack: ItemStack, world: World, attacker: LivingEntity, target: Entity, hand: Hand): ActionResult

canSwingHand

open fun canSwingHand(staffStack: ItemStack, world: World, holder: LivingEntity, hand: Hand): Boolean

disablesShield

open fun disablesShield(staffStack: ItemStack, world: World, attacker: LivingEntity, hand: Hand): Boolean

finishUsing

open override fun finishUsing(stack: ItemStack, world: World, user: LivingEntity): ItemStack

getMaxUseTime

open override fun getMaxUseTime(stack: ItemStack, user: LivingEntity): Int

getName

open override fun getName(stack: ItemStack): Text

getTranslationKey

open override fun getTranslationKey(stack: ItemStack): String

onItemEntityDestroyed

open override fun onItemEntityDestroyed(entity: ItemEntity)

onStoppedUsing

open override fun onStoppedUsing(stack: ItemStack, world: World, user: LivingEntity, remainingUseTicks: Int)

postProcessComponents

open override fun postProcessComponents(stack: ItemStack)

usageTick

open override fun usageTick(world: World, user: LivingEntity, stack: ItemStack, remainingUseTicks: Int)

use

open override fun use(world: World, user: PlayerEntity, hand: Hand): TypedActionResult<ItemStack>

useOnBlock

open override fun useOnBlock(context: ItemUsageContext): ActionResult

useOnEntity

open override fun useOnEntity(stack: ItemStack, user: PlayerEntity, entity: LivingEntity, hand: Hand): ActionResult

Inherited functions

appendTooltip

open fun appendTooltip(stack: ItemStack, context: Item.TooltipContext, tooltip: MutableList<Text>, type: TooltipType)

asItem

open override fun asItem(): Item

canApplyAtEnchantingTable

open fun canApplyAtEnchantingTable(stack: ItemStack, enchantment: Enchantment): Boolean

canBeNested

open fun canBeNested(): Boolean

canContinueUsing

open fun canContinueUsing(oldStack: ItemStack, newStack: ItemStack): Boolean

canDisableShield

open fun canDisableShield(stack: ItemStack, shield: ItemStack, entity: LivingEntity, attacker: LivingEntity): Boolean

canElytraFly

open fun canElytraFly(stack: ItemStack, entity: LivingEntity): Boolean

canEquip

open fun canEquip(stack: ItemStack, armorType: EquipmentSlot, entity: Entity): Boolean

canGrindstoneRepair

open fun canGrindstoneRepair(stack: ItemStack): Boolean

canMine

open fun canMine(state: BlockState, world: World, pos: BlockPos, miner: PlayerEntity): Boolean

canPerformAction

open fun canPerformAction(stack: ItemStack, toolAction: ToolAction): Boolean

canRepair

open fun canRepair(stack: ItemStack, ingredient: ItemStack): Boolean

canWalkOnPowderedSnow

open fun canWalkOnPowderedSnow(stack: ItemStack, wearer: LivingEntity): Boolean

createEntity

@Nullable

open fun createEntity(level: World, location: Entity, stack: ItemStack): @Nullable Entity?

doesSneakBypassUse

open fun doesSneakBypassUse(stack: ItemStack, level: WorldView, pos: BlockPos, player: PlayerEntity): Boolean

elytraFlightTick

open fun elytraFlightTick(stack: ItemStack, entity: LivingEntity, flightTicks: Int): Boolean

getArmorTexture

@Nullable

open fun getArmorTexture(stack: ItemStack, entity: Entity, slot: EquipmentSlot, layer: ArmorMaterial.Layer, inner: Boolean): @Nullable Identifier?

getAttributeModifiers

open fun ~~getAttributeModifiers~~(): AttributeModifiersComponent

open fun ~~getAttributeModifiers~~(slot: EquipmentSlot, stack: ItemStack): AttributeModifiersComponent

getBonusAttackDamage

open fun getBonusAttackDamage(target: Entity, baseAttackDamage: Float, damageSource: DamageSource): Float

getBreakSound

open fun getBreakSound(): SoundEvent

getBurnTime

open fun getBurnTime(itemStack: ItemStack, @Nullable recipeType: @Nullable RecipeType<*>?): Int

getCraftingRemainingItem

open fun getCraftingRemainingItem(itemStack: ItemStack): ItemStack

getCreatorModId

@Nullable

open fun getCreatorModId(itemStack: ItemStack): @Nullable String?

getDefaultAttributeModifiers

open fun getDefaultAttributeModifiers(stack: ItemStack): AttributeModifiersComponent

getDefaultStack

open fun getDefaultStack(): ItemStack

getDefaultTooltipHideFlags

open fun getDefaultTooltipHideFlags(@NotNull stack: @NotNull ItemStack): Int

getDrinkSound

open fun getDrinkSound(): SoundEvent

getEatSound

open fun getEatSound(): SoundEvent

getEnchantability

open fun ~~getEnchantability~~(): Int

getEnchantmentValue

open fun getEnchantmentValue(stack: ItemStack): Int

getEntityLifespan

open fun getEntityLifespan(itemStack: ItemStack, level: World): Int

getEquipmentSlot

@Nullable

open fun getEquipmentSlot(stack: ItemStack): @Nullable EquipmentSlot?

getHighlightTip

open fun getHighlightTip(item: ItemStack, displayName: Text): Text

getItemBarColor

open fun getItemBarColor(stack: ItemStack): Int

getItemBarStep

open fun getItemBarStep(stack: ItemStack): Int

getMaxCount

open fun getMaxCount(): Int

getMiningSpeed

open fun getMiningSpeed(stack: ItemStack, state: BlockState): Float

getName

open fun getName(): Text

getOrCreateTranslationKey

protected open fun getOrCreateTranslationKey(): String

getRenderPropertiesInternal

open fun getRenderPropertiesInternal(): Any

getSweepHitBox

@NotNull

open fun getSweepHitBox(@NotNull stack: @NotNull ItemStack, @NotNull player: @NotNull PlayerEntity, @NotNull target: @NotNull Entity): @NotNull Box

getTooltipData

open fun getTooltipData(stack: ItemStack): Optional<TooltipData>

getTranslationKey

open fun getTranslationKey(): String

getUseAction

open fun getUseAction(stack: ItemStack): UseAction

hasCraftingRemainingItem

open fun hasCraftingRemainingItem(stack: ItemStack): Boolean

hasCustomEntity

open fun hasCustomEntity(stack: ItemStack): Boolean

hasGlint

open fun hasGlint(stack: ItemStack): Boolean

hasRecipeRemainder

open fun ~~hasRecipeRemainder~~(): Boolean

initializeClient

open fun initializeClient(consumer: Consumer<IClientItemExtensions>)

inventoryTick

open fun inventoryTick(stack: ItemStack, world: World, entity: Entity, slot: Int, selected: Boolean)

isBookEnchantable

open fun isBookEnchantable(stack: ItemStack, book: ItemStack): Boolean

isCorrectForDrops

open fun isCorrectForDrops(stack: ItemStack, state: BlockState): Boolean

isEnabled

open fun isEnabled(enabledFeatures: FeatureSet): Boolean

isEnchantable

open fun isEnchantable(stack: ItemStack): Boolean

isEnderMask

open fun isEnderMask(stack: ItemStack, player: PlayerEntity, endermanEntity: EndermanEntity): Boolean

isItemBarVisible

open fun isItemBarVisible(stack: ItemStack): Boolean

isNetworkSynced

open fun isNetworkSynced(): Boolean

isNotReplaceableByPickAction

open fun isNotReplaceableByPickAction(stack: ItemStack, player: PlayerEntity, inventorySlot: Int): Boolean

isPiglinCurrency

open fun isPiglinCurrency(stack: ItemStack): Boolean

isUsedOnRelease

open fun isUsedOnRelease(stack: ItemStack): Boolean

makesPiglinsNeutral

open fun makesPiglinsNeutral(stack: ItemStack, wearer: LivingEntity): Boolean

onBlockStartBreak

open fun onBlockStartBreak(itemstack: ItemStack, pos: BlockPos, player: PlayerEntity): Boolean

onClicked

open fun onClicked(stack: ItemStack, otherStack: ItemStack, slot: Slot, clickType: ClickType, player: PlayerEntity, cursorStackReference: StackReference): Boolean

onCraft

open fun onCraft(stack: ItemStack, world: World)

onCraftByPlayer

open fun onCraftByPlayer(stack: ItemStack, world: World, player: PlayerEntity)

onDestroyed

open fun onDestroyed(itemEntity: ItemEntity, damageSource: DamageSource)

onDroppedByPlayer

open fun onDroppedByPlayer(item: ItemStack, player: PlayerEntity): Boolean

onEntityItemUpdate

open fun onEntityItemUpdate(stack: ItemStack, entity: ItemEntity): Boolean

onEntitySwing

open fun onEntitySwing(stack: ItemStack, entity: LivingEntity): Boolean

onHorseArmorTick

open fun onHorseArmorTick(stack: ItemStack, level: World, horse: MobEntity)

onInventoryTick

open fun onInventoryTick(stack: ItemStack, level: World, player: PlayerEntity, slotIndex: Int, selectedIndex: Int)

onItemUseFirst

open fun onItemUseFirst(stack: ItemStack, context: ItemUsageContext): ActionResult

onLeftClickEntity

open fun onLeftClickEntity(stack: ItemStack, player: PlayerEntity, entity: Entity): Boolean

onStackClicked

open fun onStackClicked(stack: ItemStack, slot: Slot, clickType: ClickType, player: PlayerEntity): Boolean

onStopUsing

open fun onStopUsing(stack: ItemStack, entity: LivingEntity, count: Int)

postDamageEntity

open fun postDamageEntity(stack: ItemStack, target: LivingEntity, attacker: LivingEntity)

postHit

open fun postHit(stack: ItemStack, target: LivingEntity, attacker: LivingEntity): Boolean

postMine

open fun postMine(stack: ItemStack, world: World, state: BlockState, pos: BlockPos, miner: LivingEntity): Boolean

shouldCauseBlockBreakReset

open fun shouldCauseBlockBreakReset(oldStack: ItemStack, newStack: ItemStack): Boolean

shouldCauseReequipAnimation

open fun shouldCauseReequipAnimation(oldStack: ItemStack, newStack: ItemStack, slotChanged: Boolean): Boolean

toString

open override fun toString(): String