Package dev.jaxydog.astral.content.item.custom

Class PlaceholderMimicItem

java.lang.Object
net.minecraft.item.Item
dev.jaxydog.astral.content.item.AstralItem
dev.jaxydog.astral.content.item.custom.PlaceholderItem
dev.jaxydog.astral.content.item.custom.PlaceholderMimicItem
All Implemented Interfaces:
Custom, Customized, LoreHolder, Registered, Registered.Common, net.fabricmc.fabric.api.item.v1.FabricItem, net.minecraft.item.Equipment, net.minecraft.item.ItemConvertible, net.minecraft.item.Vanishable, net.minecraft.resource.featuretoggle.ToggleableFeature
public class PlaceholderMimicItem extends PlaceholderItem
Implements a placeholder item, or an item that exists to mimic pre-existing items.
Since:
1.4.0

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static class 
    PlaceholderMimicItem.Group
    A group of mimicking placeholder items.

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

    net.minecraft.item.Item.Settings

    Nested classes/interfaces inherited from interface dev.jaxydog.astral.register.Registered

    Registered.All, Registered.Client, Registered.Common, Registered.Generated, Registered.Server

  • Field Summary

    Fields inherited from class net.minecraft.item.Item

    ATTACK_DAMAGE_MODIFIER_ID, ATTACK_SPEED_MODIFIER_ID, BLOCK_ITEMS, DEFAULT_MAX_COUNT, DEFAULT_MAX_USE_TIME, ITEM_BAR_STEPS

    Fields inherited from interface dev.jaxydog.astral.content.item.Customized

    CUSTOM_MODEL_DATA_KEY

    Fields inherited from interface net.minecraft.resource.featuretoggle.ToggleableFeature

    FEATURE_ENABLED_REGISTRY_KEYS

  • Constructor Summary

    Constructors
    Constructor
    Description
    PlaceholderMimicItem(String path, net.minecraft.item.Item.Settings settings, @Nullable Supplier<net.minecraft.registry.RegistryKey<net.minecraft.item.ItemGroup>> preferredGroup, Supplier<net.minecraft.item.Item> item)
    Creates a new item using the given settings.
    PlaceholderMimicItem(String path, net.minecraft.item.Item.Settings settings, Supplier<net.minecraft.item.Item> item)
    Creates a new item using the given settings.

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    allowContinuingBlockBreaking(net.minecraft.entity.player.PlayerEntity player, net.minecraft.item.ItemStack oldStack, net.minecraft.item.ItemStack newStack)
     
    boolean
    allowNbtUpdateAnimation(net.minecraft.entity.player.PlayerEntity player, net.minecraft.util.Hand hand, net.minecraft.item.ItemStack oldStack, net.minecraft.item.ItemStack newStack)
     
    void
    appendTooltip(net.minecraft.item.ItemStack stack, net.minecraft.world.World world, List<net.minecraft.text.Text> tooltip, net.minecraft.client.item.TooltipContext context)
     
    boolean
    canBeNested()
     
    boolean
    canMine(net.minecraft.block.BlockState state, net.minecraft.world.World world, net.minecraft.util.math.BlockPos pos, net.minecraft.entity.player.PlayerEntity miner)
     
    boolean
    canRepair(net.minecraft.item.ItemStack stack, net.minecraft.item.ItemStack ingredient)
     
    boolean
    damage(net.minecraft.entity.damage.DamageSource source)
     
    net.minecraft.util.TypedActionResult<net.minecraft.item.ItemStack>
    equipAndSwap(net.minecraft.item.Item item, net.minecraft.world.World world, net.minecraft.entity.player.PlayerEntity user, net.minecraft.util.Hand hand)
     
    net.minecraft.item.ItemStack
    finishUsing(net.minecraft.item.ItemStack stack, net.minecraft.world.World world, net.minecraft.entity.LivingEntity user)
     
    com.google.common.collect.Multimap<net.minecraft.entity.attribute.EntityAttribute,net.minecraft.entity.attribute.EntityAttributeModifier>
    getAttributeModifiers(net.minecraft.entity.EquipmentSlot slot)
     
    com.google.common.collect.Multimap<net.minecraft.entity.attribute.EntityAttribute,net.minecraft.entity.attribute.EntityAttributeModifier>
    getAttributeModifiers(net.minecraft.item.ItemStack stack, net.minecraft.entity.EquipmentSlot slot)
     
    Optional<Integer>
    getCustomModelData(net.minecraft.item.ItemStack stack)
    Returns the given stack's assigned custom model data.
    net.minecraft.item.ItemStack
    getDefaultStack()
     
    net.minecraft.sound.SoundEvent
    getDrinkSound()
     
    net.minecraft.sound.SoundEvent
    getEatSound()
     
    int
    getEnchantability()
     
    net.minecraft.sound.SoundEvent
    getEquipSound()
     
    net.minecraft.item.FoodComponent
    getFoodComponent()
     
    net.minecraft.item.Item
    getItem()
    Returns the mimicked item.
    net.minecraft.item.Item
    getItem(net.minecraft.item.ItemStack stack)
    Returns the mimicked item depending on the provided stack.
    int
    getItemBarColor(net.minecraft.item.ItemStack stack)
     
    int
    getItemBarStep(net.minecraft.item.ItemStack stack)
     
    int
    getMaxUseTime(net.minecraft.item.ItemStack stack)
     
    float
    getMiningSpeedMultiplier(net.minecraft.item.ItemStack stack, net.minecraft.block.BlockState state)
     
    net.minecraft.util.Rarity
    getRarity(net.minecraft.item.ItemStack stack)
     
    net.minecraft.item.ItemStack
    getRecipeRemainder(net.minecraft.item.ItemStack stack)
     
    net.minecraft.resource.featuretoggle.FeatureSet
    getRequiredFeatures()
     
    net.minecraft.entity.EquipmentSlot
    getSlotType()
     
    Optional<net.minecraft.client.item.TooltipData>
    getTooltipData(net.minecraft.item.ItemStack stack)
     
    net.minecraft.util.UseAction
    getUseAction(net.minecraft.item.ItemStack stack)
     
    boolean
    hasGlint(net.minecraft.item.ItemStack stack)
     
    boolean
    hasRecipeRemainder()
     
    void
    inventoryTick(net.minecraft.item.ItemStack stack, net.minecraft.world.World world, net.minecraft.entity.Entity entity, int slot, boolean selected)
     
    boolean
    isDamageable()
     
    boolean
    isEnabled(net.minecraft.resource.featuretoggle.FeatureSet enabledFeatures)
     
    boolean
    isEnchantable(net.minecraft.item.ItemStack stack)
     
    boolean
    isFireproof()
     
    boolean
    isFood()
     
    boolean
    isItemBarVisible(net.minecraft.item.ItemStack stack)
     
    boolean
    isNbtSynced()
     
    boolean
    isSuitableFor(net.minecraft.block.BlockState state)
     
    boolean
    isSuitableFor(net.minecraft.item.ItemStack stack, net.minecraft.block.BlockState state)
     
    boolean
    isUsedOnRelease(net.minecraft.item.ItemStack stack)
     
    boolean
    onClicked(net.minecraft.item.ItemStack stack, net.minecraft.item.ItemStack held, net.minecraft.screen.slot.Slot slot, net.minecraft.util.ClickType type, net.minecraft.entity.player.PlayerEntity player, net.minecraft.inventory.StackReference cursor)
     
    void
    onCraft(net.minecraft.item.ItemStack stack, net.minecraft.world.World world, net.minecraft.entity.player.PlayerEntity player)
     
    void
    onItemEntityDestroyed(net.minecraft.entity.ItemEntity entity)
     
    boolean
    onStackClicked(net.minecraft.item.ItemStack stack, net.minecraft.screen.slot.Slot slot, net.minecraft.util.ClickType clickType, net.minecraft.entity.player.PlayerEntity player)
     
    void
    onStoppedUsing(net.minecraft.item.ItemStack stack, net.minecraft.world.World world, net.minecraft.entity.LivingEntity user, int remainingUseTicks)
     
    boolean
    postHit(net.minecraft.item.ItemStack stack, net.minecraft.entity.LivingEntity target, net.minecraft.entity.LivingEntity attacker)
     
    boolean
    postMine(net.minecraft.item.ItemStack stack, net.minecraft.world.World world, net.minecraft.block.BlockState state, net.minecraft.util.math.BlockPos pos, net.minecraft.entity.LivingEntity miner)
     
    void
    postProcessNbt(net.minecraft.nbt.NbtCompound nbt)
     
    void
    setCustomModelData(net.minecraft.item.ItemStack stack, int data)
    Sets the given stack's custom model data.
    void
    usageTick(net.minecraft.world.World world, net.minecraft.entity.LivingEntity user, net.minecraft.item.ItemStack stack, int remainingUseTicks)
     
    net.minecraft.util.TypedActionResult<net.minecraft.item.ItemStack>
    use(net.minecraft.world.World world, net.minecraft.entity.player.PlayerEntity user, net.minecraft.util.Hand hand)
     
    net.minecraft.util.ActionResult
    useOnBlock(net.minecraft.item.ItemUsageContext context)
     
    net.minecraft.util.ActionResult
    useOnEntity(net.minecraft.item.ItemStack stack, net.minecraft.entity.player.PlayerEntity user, net.minecraft.entity.LivingEntity entity, net.minecraft.util.Hand hand)
     

    Methods inherited from class dev.jaxydog.astral.content.item.custom.PlaceholderItem

    getTranslationKey

    Methods inherited from class dev.jaxydog.astral.content.item.AstralItem

    getItemGroup, getRegistryPath

    Methods inherited from class net.minecraft.item.Item

    asItem, byRawId, fromBlock, getMaxCount, getMaxDamage, getName, getName, getOrCreateTranslationKey, getRawId, getRecipeRemainder, getRegistryEntry, getTranslationKey, isNetworkSynced, raycast, toString

    Methods inherited from class java.lang.Object

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

    Methods inherited from interface dev.jaxydog.astral.content.item.Custom

    registerCommon

    Methods inherited from interface net.minecraft.item.ItemConvertible

    asItem

    Methods inherited from interface dev.jaxydog.astral.content.item.LoreHolder

    formatLoreText, getLoreTooltips

    Methods inherited from interface dev.jaxydog.astral.register.Registered

    getRegistryId

  • Constructor Details

    • PlaceholderMimicItem

      public PlaceholderMimicItem(String path, net.minecraft.item.Item.Settings settings, @Nullable @Nullable Supplier<net.minecraft.registry.RegistryKey<net.minecraft.item.ItemGroup>> preferredGroup, Supplier<net.minecraft.item.Item> item)
      Creates a new item using the given settings.

      If the #preferredGroup supplier is null, this item will not be added to any item groups.

      Parameters:
      path - The item's identifier path.
      settings - The item's settings.
      preferredGroup - The item's preferred item group.
      Since:
      2.0.0

    • PlaceholderMimicItem

      public PlaceholderMimicItem(String path, net.minecraft.item.Item.Settings settings, Supplier<net.minecraft.item.Item> item)
      Creates a new item using the given settings.

      This item will be added to the default item group.

      Parameters:
      path - The item's identifier path.
      settings - The item's settings.
      Since:
      1.4.0

  • Method Details

    • getItem

      public net.minecraft.item.Item getItem()
      Returns the mimicked item.
      Returns:
      The item.
      Since:
      1.4.0

    • getItem

      public net.minecraft.item.Item getItem(net.minecraft.item.ItemStack stack)
      Returns the mimicked item depending on the provided stack.

      The default implementation just calls getItem().

      Parameters:
      stack - The item stack.
      Returns:
      The item.
      Since:
      1.4.0

    • getSlotType

      public net.minecraft.entity.EquipmentSlot getSlotType()
      Specified by:
      getSlotType in interface net.minecraft.item.Equipment
      Overrides:
      getSlotType in class PlaceholderItem

    • usageTick

      public void usageTick(net.minecraft.world.World world, net.minecraft.entity.LivingEntity user, net.minecraft.item.ItemStack stack, int remainingUseTicks)
      Overrides:
      usageTick in class net.minecraft.item.Item

    • onItemEntityDestroyed

      public void onItemEntityDestroyed(net.minecraft.entity.ItemEntity entity)
      Overrides:
      onItemEntityDestroyed in class net.minecraft.item.Item

    • postProcessNbt

      public void postProcessNbt(net.minecraft.nbt.NbtCompound nbt)
      Overrides:
      postProcessNbt in class net.minecraft.item.Item

    • canMine

      public boolean canMine(net.minecraft.block.BlockState state, net.minecraft.world.World world, net.minecraft.util.math.BlockPos pos, net.minecraft.entity.player.PlayerEntity miner)
      Overrides:
      canMine in class net.minecraft.item.Item

    • useOnBlock

      public net.minecraft.util.ActionResult useOnBlock(net.minecraft.item.ItemUsageContext context)
      Overrides:
      useOnBlock in class net.minecraft.item.Item

    • getMiningSpeedMultiplier

      public float getMiningSpeedMultiplier(net.minecraft.item.ItemStack stack, net.minecraft.block.BlockState state)
      Overrides:
      getMiningSpeedMultiplier in class net.minecraft.item.Item

    • use

      public net.minecraft.util.TypedActionResult<net.minecraft.item.ItemStack> use(net.minecraft.world.World world, net.minecraft.entity.player.PlayerEntity user, net.minecraft.util.Hand hand)
      Overrides:
      use in class net.minecraft.item.Item

    • finishUsing

      public net.minecraft.item.ItemStack finishUsing(net.minecraft.item.ItemStack stack, net.minecraft.world.World world, net.minecraft.entity.LivingEntity user)
      Overrides:
      finishUsing in class net.minecraft.item.Item

    • isDamageable

      public boolean isDamageable()
      Overrides:
      isDamageable in class net.minecraft.item.Item

    • isItemBarVisible

      public boolean isItemBarVisible(net.minecraft.item.ItemStack stack)
      Overrides:
      isItemBarVisible in class net.minecraft.item.Item

    • getItemBarStep

      public int getItemBarStep(net.minecraft.item.ItemStack stack)
      Overrides:
      getItemBarStep in class net.minecraft.item.Item

    • getItemBarColor

      public int getItemBarColor(net.minecraft.item.ItemStack stack)
      Overrides:
      getItemBarColor in class net.minecraft.item.Item

    • onStackClicked

      public boolean onStackClicked(net.minecraft.item.ItemStack stack, net.minecraft.screen.slot.Slot slot, net.minecraft.util.ClickType clickType, net.minecraft.entity.player.PlayerEntity player)
      Overrides:
      onStackClicked in class net.minecraft.item.Item

    • onClicked

      public boolean onClicked(net.minecraft.item.ItemStack stack, net.minecraft.item.ItemStack held, net.minecraft.screen.slot.Slot slot, net.minecraft.util.ClickType type, net.minecraft.entity.player.PlayerEntity player, net.minecraft.inventory.StackReference cursor)
      Overrides:
      onClicked in class net.minecraft.item.Item

    • postHit

      public boolean postHit(net.minecraft.item.ItemStack stack, net.minecraft.entity.LivingEntity target, net.minecraft.entity.LivingEntity attacker)
      Overrides:
      postHit in class net.minecraft.item.Item

    • postMine

      public boolean postMine(net.minecraft.item.ItemStack stack, net.minecraft.world.World world, net.minecraft.block.BlockState state, net.minecraft.util.math.BlockPos pos, net.minecraft.entity.LivingEntity miner)
      Overrides:
      postMine in class net.minecraft.item.Item

    • isSuitableFor

      public boolean isSuitableFor(net.minecraft.block.BlockState state)
      Overrides:
      isSuitableFor in class net.minecraft.item.Item

    • useOnEntity

      public net.minecraft.util.ActionResult useOnEntity(net.minecraft.item.ItemStack stack, net.minecraft.entity.player.PlayerEntity user, net.minecraft.entity.LivingEntity entity, net.minecraft.util.Hand hand)
      Overrides:
      useOnEntity in class net.minecraft.item.Item

    • isNbtSynced

      public boolean isNbtSynced()
      Overrides:
      isNbtSynced in class net.minecraft.item.Item

    • hasRecipeRemainder

      public boolean hasRecipeRemainder()
      Overrides:
      hasRecipeRemainder in class net.minecraft.item.Item

    • inventoryTick

      public void inventoryTick(net.minecraft.item.ItemStack stack, net.minecraft.world.World world, net.minecraft.entity.Entity entity, int slot, boolean selected)
      Overrides:
      inventoryTick in class net.minecraft.item.Item

    • onCraft

      public void onCraft(net.minecraft.item.ItemStack stack, net.minecraft.world.World world, net.minecraft.entity.player.PlayerEntity player)
      Overrides:
      onCraft in class net.minecraft.item.Item

    • getUseAction

      public net.minecraft.util.UseAction getUseAction(net.minecraft.item.ItemStack stack)
      Overrides:
      getUseAction in class net.minecraft.item.Item

    • getMaxUseTime

      public int getMaxUseTime(net.minecraft.item.ItemStack stack)
      Overrides:
      getMaxUseTime in class net.minecraft.item.Item

    • onStoppedUsing

      public void onStoppedUsing(net.minecraft.item.ItemStack stack, net.minecraft.world.World world, net.minecraft.entity.LivingEntity user, int remainingUseTicks)
      Overrides:
      onStoppedUsing in class net.minecraft.item.Item

    • getTooltipData

      public Optional<net.minecraft.client.item.TooltipData> getTooltipData(net.minecraft.item.ItemStack stack)
      Overrides:
      getTooltipData in class net.minecraft.item.Item

    • hasGlint

      public boolean hasGlint(net.minecraft.item.ItemStack stack)
      Overrides:
      hasGlint in class net.minecraft.item.Item

    • getRarity

      public net.minecraft.util.Rarity getRarity(net.minecraft.item.ItemStack stack)
      Overrides:
      getRarity in class net.minecraft.item.Item

    • isEnchantable

      public boolean isEnchantable(net.minecraft.item.ItemStack stack)
      Overrides:
      isEnchantable in class net.minecraft.item.Item

    • getEnchantability

      public int getEnchantability()
      Overrides:
      getEnchantability in class net.minecraft.item.Item

    • canRepair

      public boolean canRepair(net.minecraft.item.ItemStack stack, net.minecraft.item.ItemStack ingredient)
      Overrides:
      canRepair in class net.minecraft.item.Item

    • getAttributeModifiers

      public com.google.common.collect.Multimap<net.minecraft.entity.attribute.EntityAttribute,net.minecraft.entity.attribute.EntityAttributeModifier> getAttributeModifiers(net.minecraft.entity.EquipmentSlot slot)
      Overrides:
      getAttributeModifiers in class net.minecraft.item.Item

    • isUsedOnRelease

      public boolean isUsedOnRelease(net.minecraft.item.ItemStack stack)
      Overrides:
      isUsedOnRelease in class net.minecraft.item.Item

    • getDefaultStack

      public net.minecraft.item.ItemStack getDefaultStack()
      Overrides:
      getDefaultStack in class net.minecraft.item.Item

    • isFood

      public boolean isFood()
      Overrides:
      isFood in class net.minecraft.item.Item

    • getFoodComponent

      public net.minecraft.item.FoodComponent getFoodComponent()
      Overrides:
      getFoodComponent in class net.minecraft.item.Item

    • getDrinkSound

      public net.minecraft.sound.SoundEvent getDrinkSound()
      Overrides:
      getDrinkSound in class net.minecraft.item.Item

    • getEatSound

      public net.minecraft.sound.SoundEvent getEatSound()
      Overrides:
      getEatSound in class net.minecraft.item.Item

    • isFireproof

      public boolean isFireproof()
      Overrides:
      isFireproof in class net.minecraft.item.Item

    • damage

      public boolean damage(net.minecraft.entity.damage.DamageSource source)
      Overrides:
      damage in class net.minecraft.item.Item

    • canBeNested

      public boolean canBeNested()
      Overrides:
      canBeNested in class net.minecraft.item.Item

    • getRequiredFeatures

      public net.minecraft.resource.featuretoggle.FeatureSet getRequiredFeatures()
      Specified by:
      getRequiredFeatures in interface net.minecraft.resource.featuretoggle.ToggleableFeature
      Overrides:
      getRequiredFeatures in class net.minecraft.item.Item

    • appendTooltip

      public void appendTooltip(net.minecraft.item.ItemStack stack, net.minecraft.world.World world, List<net.minecraft.text.Text> tooltip, net.minecraft.client.item.TooltipContext context)
      Overrides:
      appendTooltip in class AstralItem

    • isEnabled

      public boolean isEnabled(net.minecraft.resource.featuretoggle.FeatureSet enabledFeatures)

    • allowNbtUpdateAnimation

      public boolean allowNbtUpdateAnimation(net.minecraft.entity.player.PlayerEntity player, net.minecraft.util.Hand hand, net.minecraft.item.ItemStack oldStack, net.minecraft.item.ItemStack newStack)

    • allowContinuingBlockBreaking

      public boolean allowContinuingBlockBreaking(net.minecraft.entity.player.PlayerEntity player, net.minecraft.item.ItemStack oldStack, net.minecraft.item.ItemStack newStack)

    • getAttributeModifiers

      public com.google.common.collect.Multimap<net.minecraft.entity.attribute.EntityAttribute,net.minecraft.entity.attribute.EntityAttributeModifier> getAttributeModifiers(net.minecraft.item.ItemStack stack, net.minecraft.entity.EquipmentSlot slot)

    • isSuitableFor

      public boolean isSuitableFor(net.minecraft.item.ItemStack stack, net.minecraft.block.BlockState state)

    • getRecipeRemainder

      public net.minecraft.item.ItemStack getRecipeRemainder(net.minecraft.item.ItemStack stack)

    • getEquipSound

      public net.minecraft.sound.SoundEvent getEquipSound()

    • equipAndSwap

      public net.minecraft.util.TypedActionResult<net.minecraft.item.ItemStack> equipAndSwap(net.minecraft.item.Item item, net.minecraft.world.World world, net.minecraft.entity.player.PlayerEntity user, net.minecraft.util.Hand hand)

    • getCustomModelData

      public Optional<Integer> getCustomModelData(net.minecraft.item.ItemStack stack)
      Description copied from interface: Customized
      Returns the given stack's assigned custom model data.

      If the key is present but is not assigned to a valid number, Optional.of(0) is returned.

      Parameters:
      stack - The item stack.
      Returns:
      The custom model data.

    • setCustomModelData

      public void setCustomModelData(net.minecraft.item.ItemStack stack, int data)
      Description copied from interface: Customized
      Sets the given stack's custom model data.
      Parameters:
      stack - The item stack.
      data - The custom model data.