ShrineOrbItem (Pixelmon 1.16.5-9.1.7-pipe20926 API)

java.lang.Object
- net.minecraftforge.registries.ForgeRegistryEntry<net.minecraft.item.Item>
- - net.minecraft.item.Item
  - - com.pixelmonmod.pixelmon.items.ShrineOrbItem

All Implemented Interfaces:

net.minecraft.util.IItemProvider, net.minecraftforge.common.extensions.IForgeItem, net.minecraftforge.registries.IForgeRegistryEntry<net.minecraft.item.Item>
```
public class ShrineOrbItem
extends net.minecraft.item.Item
```
An orb used to activate a Legendary bird shrine. Incrementation of the damage value is done in PlayerParticipant.

Nested Class Summary
- Nested classes/interfaces inherited from class net.minecraft.item.Item
  net.minecraft.item.Item.Properties
- Nested classes/interfaces inherited from class net.minecraftforge.registries.ForgeRegistryEntry
  net.minecraftforge.registries.ForgeRegistryEntry.UncheckedRegistryEntry<V extends net.minecraftforge.registries.IForgeRegistryEntry<V>>

Field Summary

Fields
Modifier and Type Field and Description

static int full
The number of KOs needed for the orb to be full.

java.lang.String itemNames
The name of the orb.
- Fields inherited from class net.minecraft.item.Item
  BASE_ATTACK_DAMAGE_UUID, BASE_ATTACK_SPEED_UUID, BY_BLOCK, canRepair, category, random
- Fields inherited from class net.minecraftforge.registries.ForgeRegistryEntry
  delegate

Fields
Modifier and Type	Field and Description
`static int`	`full` The number of KOs needed for the orb to be full.
`java.lang.String`	`itemNames` The name of the orb.

Constructor Summary

Constructors
Constructor and Description

ShrineOrbItem(ShrineType shrine)
Initializes an orb.

Constructors
Constructor and Description
`ShrineOrbItem(ShrineType shrine)` Initializes an orb.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`canApplyAtEnchantingTable(net.minecraft.item.ItemStack stack, net.minecraft.enchantment.Enchantment enchantment)`
`void`	`fillItemCategory(net.minecraft.item.ItemGroup tab, net.minecraft.util.NonNullList<net.minecraft.item.ItemStack> items)` Specify how this item will appear in the creative item menu.
`double`	`getDurabilityForDisplay(net.minecraft.item.ItemStack stack)` Queries the percentage of the 'Durability' bar that should be drawn.
`void`	`inventoryTick(net.minecraft.item.ItemStack par1ItemStack, net.minecraft.world.World par2World, net.minecraft.entity.Entity par3Entity, int par4, boolean par5)`
`boolean`	`isBookEnchantable(net.minecraft.item.ItemStack stack, net.minecraft.item.ItemStack book)`
`boolean`	`isEnchantable(net.minecraft.item.ItemStack p_77616_1_)`
`boolean`	`showDurabilityBar(net.minecraft.item.ItemStack stack)` We override this so that orbs with full damage (i.e.
`net.minecraft.util.ActionResult<net.minecraft.item.ItemStack>`	`use(net.minecraft.world.World worldIn, net.minecraft.entity.player.PlayerEntity playerIn, net.minecraft.util.Hand hand)`

Methods inherited from class net.minecraft.item.Item
allowdedIn, appendHoverText, asItem, byBlock, byId, canAttackBlock, canBeDepleted, canBeHurtBy, finishUsingItem, getCraftingRemainingItem, getDefaultAttributeModifiers, getDefaultInstance, getDescription, getDescriptionId, getDescriptionId, getDestroySpeed, getDrinkingSound, getEatingSound, getEnchantmentValue, getFoodProperties, getHarvestLevel, getId, getItemCategory, getItemStackTileEntityRenderer, getMaxDamage, getMaxStackSize, getName, getOrCreateDescriptionId, getPlayerPOVHitResult, getRarity, getTags, getToolTypes, getUseAnimation, getUseDuration, hasCraftingRemainingItem, hurtEnemy, interactLivingEntity, is, isComplex, isCorrectToolForDrops, isEdible, isFireResistant, isFoil, isRepairable, isValidRepairItem, mineBlock, onCraftedBy, onUseTick, releaseUsing, shouldOverrideMultiplayerNbt, toString, useOn, useOnRelease, verifyTagAfterLoad

Methods inherited from class net.minecraftforge.registries.ForgeRegistryEntry
getRegistryName, getRegistryType, setRegistryName, setRegistryName, setRegistryName

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface net.minecraftforge.common.extensions.IForgeItem
canContinueUsing, canDisableShield, canElytraFly, canEquip, canHarvestBlock, createEntity, damageItem, doesSneakBypassUse, elytraFlightTick, getArmorModel, getArmorTexture, getAttributeModifiers, getBurnTime, getBurnTime, getContainerItem, getCreativeTabs, getCreatorModId, getDamage, getEntityLifespan, getEquipmentSlot, getFontRenderer, getHighlightTip, getItem, getItemEnchantability, getItemStackLimit, getMaxDamage, getRGBDurabilityForDisplay, getShareTag, getSmeltingExperience, getXpRepairRatio, hasContainerItem, hasCustomEntity, initCapabilities, isDamageable, isDamaged, isEnderMask, isPiglinCurrency, isShield, makesPiglinsNeutral, onArmorTick, onBlockStartBreak, onDroppedByPlayer, onEntityItemUpdate, onEntitySwing, onHorseArmorTick, onItemUseFirst, onLeftClickEntity, onUsingTick, readShareTag, renderHelmetOverlay, setDamage, shouldCauseBlockBreakReset, shouldCauseReequipAnimation

- Field Detail
  - full
```
public static int full
```
    The number of KOs needed for the orb to be full.
  - itemNames
```
public java.lang.String itemNames
```
    The name of the orb.
- Constructor Detail
  - ShrineOrbItem
```
public ShrineOrbItem(ShrineType shrine)
```
    Initializes an orb.
    
    Parameters:
    
    shrine - The shrine the orb is compatible with.
- Method Detail
  - inventoryTick
```
public void inventoryTick(net.minecraft.item.ItemStack par1ItemStack,
                          net.minecraft.world.World par2World,
                          net.minecraft.entity.Entity par3Entity,
                          int par4,
                          boolean par5)
```
    Overrides:
    
    inventoryTick in class net.minecraft.item.Item
  - use
```
public net.minecraft.util.ActionResult<net.minecraft.item.ItemStack> use(net.minecraft.world.World worldIn,
                                                                         net.minecraft.entity.player.PlayerEntity playerIn,
                                                                         net.minecraft.util.Hand hand)
```
    Overrides:
    
    use in class net.minecraft.item.Item
  - showDurabilityBar
```
public boolean showDurabilityBar(net.minecraft.item.ItemStack stack)
```
    We override this so that orbs with full damage (i.e. have defeated the max amount of Pokémon necessary) don't display their durability bar because it is redundant info. The texture change when the durability maxes out already provides that info.
    
    Parameters:
    
    stack - The current Item Stack
    
    Returns:
    
    True if it should render the 'durability' bar.
  - getDurabilityForDisplay
```
public double getDurabilityForDisplay(net.minecraft.item.ItemStack stack)
```
    Queries the percentage of the 'Durability' bar that should be drawn. We override this to reverse the value on the durability bar (i.e. we make it so that if the item has 1 damage, instead of displaying the durability bar as almost full, it displays as almost depleted.
    
    Parameters:
    
    stack - A shrine orb item stack.
    
    Returns:
    
    0.0 for 0% (no damage / empty bar), 1.0 for 100% (fully damaged / full bar)
  - isEnchantable
```
public boolean isEnchantable(net.minecraft.item.ItemStack p_77616_1_)
```
    Overrides:
    
    isEnchantable in class net.minecraft.item.Item
  - canApplyAtEnchantingTable
```
public boolean canApplyAtEnchantingTable(net.minecraft.item.ItemStack stack,
                                         net.minecraft.enchantment.Enchantment enchantment)
```
  - isBookEnchantable
```
public boolean isBookEnchantable(net.minecraft.item.ItemStack stack,
                                 net.minecraft.item.ItemStack book)
```
  - fillItemCategory
```
public void fillItemCategory(net.minecraft.item.ItemGroup tab,
                             net.minecraft.util.NonNullList<net.minecraft.item.ItemStack> items)
```
    Specify how this item will appear in the creative item menu.
    
    Overrides:
    
    fillItemCategory in class net.minecraft.item.Item
    
    Parameters:
    
    tab - The ItemGroup tab this will appear in. Shrine Orbs appear in the MISC tab.
    
    items - The list of items in the creative menu that we add the orb to.

Class ShrineOrbItem

Nested Class Summary

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

Nested classes/interfaces inherited from class net.minecraftforge.registries.ForgeRegistryEntry

Field Summary

Fields inherited from class net.minecraft.item.Item

Fields inherited from class net.minecraftforge.registries.ForgeRegistryEntry

Constructor Summary

Method Summary

Methods inherited from class net.minecraft.item.Item

Methods inherited from class net.minecraftforge.registries.ForgeRegistryEntry

Methods inherited from class java.lang.Object

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

Field Detail

full

itemNames

Constructor Detail

ShrineOrbItem

Method Detail

inventoryTick

use

showDurabilityBar

getDurabilityForDisplay

isEnchantable

canApplyAtEnchantingTable

isBookEnchantable

fillItemCategory