Package com.minecolonies.core.items

Class AbstractItemScroll

java.lang.Object
net.minecraft.world.item.Item
com.minecolonies.core.items.AbstractItemMinecolonies
com.minecolonies.core.items.AbstractItemScroll
All Implemented Interfaces:
net.minecraft.world.flag.FeatureElement, net.minecraft.world.level.ItemLike, net.minecraftforge.common.extensions.IForgeItem
Direct Known Subclasses:
ItemScrollBuff, ItemScrollColonyAreaTP, ItemScrollColonyTP, ItemScrollGuardHelp, ItemScrollHighlight
public abstract class AbstractItemScroll extends AbstractItemMinecolonies
Scroll items base class, does colony registering/checks.

  • Nested Class Summary

    Nested classes/interfaces inherited from class net.minecraft.world.item.Item

    net.minecraft.world.item.Item.Properties

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    FAIL_RESPONSES_TOTAL
     
    static final String
    TAG_BUILDING_POS
     
    static final String
    TAG_CACHED_COLONY_NAME
     
    static final String
    TAG_COLONY_DIM
     

    Fields inherited from class net.minecraft.world.item.Item

    BASE_ATTACK_DAMAGE_UUID, BASE_ATTACK_SPEED_UUID, BY_BLOCK, canRepair, EAT_DURATION, MAX_BAR_WIDTH, MAX_STACK_SIZE

    Fields inherited from interface net.minecraft.world.flag.FeatureElement

    FILTERED_REGISTRIES

  • Constructor Summary

    Constructors
    Constructor
    Description
    AbstractItemScroll(String name, net.minecraft.world.item.Item.Properties properties)
    Sets the name, creative tab, and registers the item.

  • Method Summary

    Modifier and Type
    Method
    Description
    net.minecraft.world.item.ItemStack
    finishUsingItem(net.minecraft.world.item.ItemStack itemStack, net.minecraft.world.level.Level world, net.minecraft.world.entity.LivingEntity entityLiving)
     
    protected IColony
    getColony(net.minecraft.world.item.ItemStack stack)
    Get the colony from the stack
    protected IColony
    getColonyView(net.minecraft.world.item.ItemStack stack)
    Get the colony view from the stack
    net.minecraft.world.item.UseAnim
    getUseAnimation(net.minecraft.world.item.ItemStack itemStack)
     
    int
    getUseDuration(net.minecraft.world.item.ItemStack itemStack)
     
    protected abstract boolean
    needsColony()
    Whether this items need to register to a colony
    protected abstract net.minecraft.world.item.ItemStack
    onItemUseSuccess(net.minecraft.world.item.ItemStack itemStack, net.minecraft.world.level.Level world, net.minecraft.server.level.ServerPlayer player)
    Called when the item gets used
    net.minecraft.world.InteractionResultHolder<net.minecraft.world.item.ItemStack>
    use(net.minecraft.world.level.Level world, net.minecraft.world.entity.player.Player player, net.minecraft.world.InteractionHand hand)
     
    @NotNull net.minecraft.world.InteractionResult
    useOn(net.minecraft.world.item.context.UseOnContext ctx)
     

    Methods inherited from class net.minecraft.world.item.Item

    appendHoverText, asItem, builtInRegistryHolder, byBlock, byId, canAttackBlock, canBeDepleted, canBeHurtBy, canFitInsideContainerItems, getBarColor, getBarWidth, getCraftingRemainingItem, getDefaultAttributeModifiers, getDefaultInstance, getDescription, getDescriptionId, getDescriptionId, getDestroySpeed, getDrinkingSound, getEatingSound, getEnchantmentValue, getFoodProperties, getId, getMaxDamage, getMaxStackSize, getName, getOrCreateDescriptionId, getPlayerPOVHitResult, getRarity, getRenderPropertiesInternal, getTooltipImage, hasCraftingRemainingItem, hurtEnemy, initializeClient, interactLivingEntity, inventoryTick, isBarVisible, isComplex, isCorrectToolForDrops, isEdible, isEnchantable, isFireResistant, isFoil, isRepairable, isValidRepairItem, mineBlock, onCraftedBy, onDestroyed, onUseTick, overrideOtherStackedOnMe, overrideStackedOnOther, releaseUsing, requiredFeatures, shouldOverrideMultiplayerNbt, toString, useOnRelease, verifyTagAfterLoad

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

    Methods inherited from interface net.minecraft.world.flag.FeatureElement

    isEnabled

    Methods inherited from interface net.minecraftforge.common.extensions.IForgeItem

    canApplyAtEnchantingTable, canContinueUsing, canDisableShield, canElytraFly, canEquip, canGrindstoneRepair, canPerformAction, canWalkOnPowderedSnow, createEntity, damageItem, doesSneakBypassUse, elytraFlightTick, getAllEnchantments, getArmorTexture, getAttributeModifiers, getBurnTime, getCraftingRemainingItem, getCreatorModId, getDamage, getDefaultTooltipHideFlags, getEnchantmentLevel, getEnchantmentValue, getEntityLifespan, getEquipmentSlot, getFoodProperties, getHighlightTip, getMaxDamage, getMaxStackSize, getShareTag, getSweepHitBox, getXpRepairRatio, hasCraftingRemainingItem, hasCustomEntity, initCapabilities, isBookEnchantable, isCorrectToolForDrops, isDamageable, isDamaged, isEnderMask, isNotReplaceableByPickAction, isPiglinCurrency, makesPiglinsNeutral, onArmorTick, onBlockStartBreak, onDestroyed, onDroppedByPlayer, onEntityItemUpdate, onEntitySwing, onHorseArmorTick, onItemUseFirst, onLeftClickEntity, onStopUsing, readShareTag, setDamage, shouldCauseBlockBreakReset, shouldCauseReequipAnimation

  • Field Details

  • Constructor Details

    • AbstractItemScroll

      public AbstractItemScroll(String name, net.minecraft.world.item.Item.Properties properties)
      Sets the name, creative tab, and registers the item.
      Parameters:
      name - The name of this item
      properties - the properties.

  • Method Details

    • getUseDuration

      public int getUseDuration(net.minecraft.world.item.ItemStack itemStack)
      Overrides:
      getUseDuration in class net.minecraft.world.item.Item

    • getUseAnimation

      public net.minecraft.world.item.UseAnim getUseAnimation(net.minecraft.world.item.ItemStack itemStack)
      Overrides:
      getUseAnimation in class net.minecraft.world.item.Item

    • finishUsingItem

      public net.minecraft.world.item.ItemStack finishUsingItem(net.minecraft.world.item.ItemStack itemStack, net.minecraft.world.level.Level world, net.minecraft.world.entity.LivingEntity entityLiving)
      Overrides:
      finishUsingItem in class net.minecraft.world.item.Item

    • onItemUseSuccess

      protected abstract net.minecraft.world.item.ItemStack onItemUseSuccess(net.minecraft.world.item.ItemStack itemStack, net.minecraft.world.level.Level world, net.minecraft.server.level.ServerPlayer player)
      Called when the item gets used
      Parameters:
      itemStack - stack thats used
      world - world its used in
      player - player its used by
      Returns:
      stack

    • use

      public net.minecraft.world.InteractionResultHolder<net.minecraft.world.item.ItemStack> use(net.minecraft.world.level.Level world, net.minecraft.world.entity.player.Player player, net.minecraft.world.InteractionHand hand)
      Overrides:
      use in class net.minecraft.world.item.Item

    • useOn

      @NotNull public @NotNull net.minecraft.world.InteractionResult useOn(net.minecraft.world.item.context.UseOnContext ctx)
      Overrides:
      useOn in class net.minecraft.world.item.Item

    • needsColony

      protected abstract boolean needsColony()
      Whether this items need to register to a colony
      Returns:
      true if so

    • getColony

      protected IColony getColony(net.minecraft.world.item.ItemStack stack)
      Get the colony from the stack
      Parameters:
      stack - to use
      Returns:
      colony

    • getColonyView

      protected IColony getColonyView(net.minecraft.world.item.ItemStack stack)
      Get the colony view from the stack
      Parameters:
      stack - to use
      Returns:
      colony