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): EventResult

attackEntity

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

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)

arch$holder

open override fun arch$holder(): RegistryEntry<Item>

arch$registryName

@Nullable

open fun arch$registryName(): @Nullable Identifier?

asItem

open override fun asItem(): Item

canBeNested

open fun canBeNested(): Boolean

canMine

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

canRepair

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

getAttributeModifiers

open fun ~~getAttributeModifiers~~(): AttributeModifiersComponent

getBonusAttackDamage

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

getBreakSound

open fun getBreakSound(): SoundEvent

getDefaultStack

open fun getDefaultStack(): ItemStack

getDrinkSound

open fun getDrinkSound(): SoundEvent

getEatSound

open fun getEatSound(): SoundEvent

getEnchantability

open fun getEnchantability(): Int

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

getTooltipData

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

getTranslationKey

open fun getTranslationKey(): String

getUseAction

open fun getUseAction(stack: ItemStack): UseAction

hasGlint

open fun hasGlint(stack: ItemStack): Boolean

hasRecipeRemainder

open fun hasRecipeRemainder(): Boolean

inventoryTick

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

isCorrectForDrops

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

isEnabled

open fun isEnabled(enabledFeatures: FeatureSet): Boolean

isEnchantable

open fun isEnchantable(stack: ItemStack): Boolean

isItemBarVisible

open fun isItemBarVisible(stack: ItemStack): Boolean

isNetworkSynced

open fun isNetworkSynced(): Boolean

isUsedOnRelease

open fun isUsedOnRelease(stack: ItemStack): 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)

onStackClicked

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

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

toString

open override fun toString(): String