ItemStack ([Javadoc]MinecraftForge(forge:1.15.2-31.1.0 / mcp:SS

java.lang.Object
- net.minecraftforge.common.capabilities.CapabilityProvider<ItemStack>
- - net.minecraft.item.ItemStack

すべての実装されたインタフェース:

ICapabilityProvider, ICapabilitySerializable<CompoundNBT>, IForgeItemStack, INBTSerializable<CompoundNBT>
```
public final class ItemStack
extends CapabilityProvider<ItemStack>
implements IForgeItemStack
```

フィールドのサマリー

フィールド
修飾子とタイプフィールドと説明

static java.text.DecimalFormat DECIMALFORMAT

static ItemStack EMPTY

フィールド
修飾子とタイプ	フィールドと説明
`static java.text.DecimalFormat`	`DECIMALFORMAT`
`static ItemStack`	`EMPTY`

コンストラクタのサマリー

コンストラクタ
コンストラクタと説明
`ItemStack(IItemProvider itemIn)`
`ItemStack(IItemProvider itemIn, int count)`
`ItemStack(IItemProvider itemIn, int count, CompoundNBT capNBT)`

メソッドのサマリー

すべてのメソッド staticメソッドインスタンス・メソッド concreteメソッド
修飾子とタイプ	メソッドと説明
`void`	`addAttributeModifier(java.lang.String attributeName, AttributeModifier modifier, EquipmentSlotType equipmentSlot)`
`void`	`addEnchantment(Enchantment ench, int level)` Adds an enchantment with a desired level on the ItemStack.
`static void`	`addEnchantmentTooltips(java.util.List<ITextComponent> p_222120_0_, ListNBT p_222120_1_)`
`static boolean`	`areItemsEqual(ItemStack stackA, ItemStack stackB)` Compares Item and damage value of the two stacks
`static boolean`	`areItemsEqualIgnoreDurability(ItemStack stackA, ItemStack stackB)`
`static boolean`	`areItemStacksEqual(ItemStack stackA, ItemStack stackB)` compares ItemStack argument1 with ItemStack argument2; returns true if both ItemStacks are equal
`static boolean`	`areItemStackTagsEqual(ItemStack stackA, ItemStack stackB)`
`boolean`	`attemptDamageItem(int amount, java.util.Random rand, ServerPlayerEntity damager)` Attempts to damage the ItemStack with par1 amount of damage, If the ItemStack has the Unbreaking enchantment there is a chance for each point of damage to be negated.
`boolean`	`canDestroy(NetworkTagManager p_206848_1_, CachedBlockInfo p_206848_2_)`
`boolean`	`canHarvestBlock(BlockState blockIn)` Check whether the given Block can be harvested using this ItemStack.
`boolean`	`canPlaceOn(NetworkTagManager p_206847_1_, CachedBlockInfo p_206847_2_)`
`void`	`clearCustomName()` Clear any custom name set for this ItemStack
`ItemStack`	`copy()` Returns a new stack with the same properties.
`<T extends LivingEntity> void`	`damageItem(int amount, T entityIn, java.util.function.Consumer<T> onBroken)`
`void`	`deserializeNBT(CompoundNBT nbt)`
`void`	`func_222121_b(World worldIn, LivingEntity livingEntityIn, int countIn)`
`SoundEvent`	`func_226629_F_()`
`SoundEvent`	`func_226630_G_()`
`int`	`getAnimationsToGo()`
`com.google.common.collect.Multimap<java.lang.String,AttributeModifier>`	`getAttributeModifiers(EquipmentSlotType equipmentSlot)` Gets the attribute modifiers for this ItemStack.
`CompoundNBT`	`getChildTag(java.lang.String key)` Get an NBTTagCompound from this stack's NBT data.
`int`	`getCount()`
`int`	`getDamage()`
`float`	`getDestroySpeed(BlockState blockIn)`
`ITextComponent`	`getDisplayName()`
`ListNBT`	`getEnchantmentTagList()`
`Item`	`getItem()` Returns the object corresponding to the stack.
`ItemFrameEntity`	`getItemFrame()` Return the item frame this stack is on.
`int`	`getMaxDamage()` Returns the max damage an item in the stack can take.
`int`	`getMaxStackSize()` Returns maximum size of the stack.
`CompoundNBT`	`getOrCreateChildTag(java.lang.String key)`
`CompoundNBT`	`getOrCreateTag()`
`Rarity`	`getRarity()`
`int`	`getRepairCost()` Get this stack's repair cost, or 0 if no repair cost is defined.
`CompoundNBT`	`getTag()`
`ITextComponent`	`getTextComponent()` Get a ChatComponent for this Item's display name that shows this Item on hover
`java.util.List<ITextComponent>`	`getTooltip(PlayerEntity playerIn, ITooltipFlag advanced)` Return a list of strings containing information about the item
`java.lang.String`	`getTranslationKey()`
`UseAction`	`getUseAction()`
`int`	`getUseDuration()`
`void`	`grow(int count)`
`boolean`	`hasDisplayName()` Returns true if the itemstack has a display name
`boolean`	`hasEffect()`
`boolean`	`hasTag()` Returns true if the ItemStack has an NBTTagCompound.
`void`	`hitEntity(LivingEntity entityIn, PlayerEntity playerIn)` Calls the delegated method to the Item to damage the incoming Entity, and if necessary, triggers a stats increase.
`boolean`	`interactWithEntity(PlayerEntity playerIn, LivingEntity entityIn, Hand hand)`
`void`	`inventoryTick(World worldIn, Entity entityIn, int inventorySlot, boolean isCurrentItem)` Called each tick as long the ItemStack in on player inventory.
`boolean`	`isCrossbowStack()`
`boolean`	`isDamageable()` true if this itemStack is damageable
`boolean`	`isDamaged()` returns true when a damageable item is damaged
`boolean`	`isEmpty()`
`boolean`	`isEnchantable()` True if it is a tool and has no enchantments to begin with
`boolean`	`isEnchanted()` True if the item has enchantment data
`boolean`	`isFood()`
`boolean`	`isItemEqual(ItemStack other)` compares ItemStack argument to the instance ItemStack; returns true if the Items contained in both ItemStacks are equal
`boolean`	`isItemEqualIgnoreDurability(ItemStack stack)`
`boolean`	`isOnItemFrame()` Return whether this stack is on an item frame.
`boolean`	`isStackable()` Returns true if the ItemStack can hold 2 or more units of the item.
`void`	`onBlockDestroyed(World worldIn, BlockState blockIn, BlockPos pos, PlayerEntity playerIn)` Called when a Block is destroyed using this ItemStack
`void`	`onCrafting(World worldIn, PlayerEntity playerIn, int amount)`
`ActionResultType`	`onItemUse(ItemUseContext context)`
`ItemStack`	`onItemUseFinish(World worldIn, LivingEntity entityLiving)` Called when the item in use count reach 0, e.g. item food eaten.
`ActionResultType`	`onItemUseFirst(ItemUseContext context)`
`void`	`onPlayerStoppedUsing(World worldIn, LivingEntity entityLiving, int timeLeft)` Called when the player releases the use item button.
`static ItemStack`	`read(CompoundNBT compound)`
`void`	`removeChildTag(java.lang.String p_196083_1_)`
`void`	`setAnimationsToGo(int animations)`
`void`	`setCount(int count)`
`void`	`setDamage(int damage)`
`ItemStack`	`setDisplayName(ITextComponent name)`
`void`	`setItemFrame(ItemFrameEntity frame)` Set the item frame this stack is on.
`void`	`setRepairCost(int cost)` Set this stack's repair cost.
`void`	`setTag(CompoundNBT nbt)` Assigns a NBTTagCompound to the ItemStack, minecraft validates that only non-stackable items can have it.
`void`	`setTagInfo(java.lang.String key, INBT value)`
`void`	`shrink(int count)`
`ItemStack`	`split(int amount)` Splits off a stack of the given amount of this stack and reduces this stack by the amount.
`java.lang.String`	`toString()`
`ActionResult<ItemStack>`	`useItemRightClick(World worldIn, PlayerEntity playerIn, Hand hand)` Called whenr the item stack is equipped and right clicked.
`CompoundNBT`	`write(CompoundNBT nbt)` Write the stack fields to a NBT object.

クラスから継承されたメソッド net.minecraftforge.common.capabilities.CapabilityProvider
areCapsCompatible, areCapsCompatible, deserializeCaps, gatherCapabilities, gatherCapabilities, getCapabilities, getCapability, invalidateCaps, reviveCaps, serializeCaps

クラスから継承されたメソッド java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

インタフェースから継承されたメソッド net.minecraftforge.common.extensions.IForgeItemStack
areShareTagsEqual, canApplyAtEnchantingTable, canDisableShield, canEquip, doesSneakBypassUse, equals, getBurnTime, getContainerItem, getEntityLifespan, getEquipmentSlot, getHarvestLevel, getHighlightTip, getItemEnchantability, getShareTag, getStack, getToolTypes, getXpRepairRatio, hasContainerItem, isBeaconPayment, isBookEnchantable, isRepairable, isShield, onArmorTick, onBlockStartBreak, onDroppedByPlayer, onEntityItemUpdate, onEntitySwing, onHorseArmorTick, onUsingTick, readShareTag, serializeNBT, shouldCauseBlockBreakReset

インタフェースから継承されたメソッド net.minecraftforge.common.capabilities.ICapabilityProvider
getCapability, getCapability

フィールドの詳細

EMPTY
```
public static final ItemStack EMPTY
```

DECIMALFORMAT

public static final java.text.DecimalFormat DECIMALFORMAT

コンストラクタの詳細

ItemStack

public ItemStack(IItemProvider itemIn)

ItemStack

public ItemStack(IItemProvider itemIn,
                 int count)

ItemStack

public ItemStack(IItemProvider itemIn,
                 int count,
                 @Nullable
                 CompoundNBT capNBT)

メソッドの詳細

read

public static ItemStack read(CompoundNBT compound)

isEmpty
```
public boolean isEmpty()
```

split
```
public ItemStack split(int amount)
```
Splits off a stack of the given amount of this stack and reduces this stack by the amount.

getItem
```
public Item getItem()
```
Returns the object corresponding to the stack.

onItemUse

public ActionResultType onItemUse(ItemUseContext context)

onItemUseFirst
```
public ActionResultType onItemUseFirst(ItemUseContext context)
```
定義:

onItemUseFirst インタフェース内 IForgeItemStack

getDestroySpeed

public float getDestroySpeed(BlockState blockIn)

useItemRightClick

public ActionResult<ItemStack> useItemRightClick(World worldIn,
                                                 PlayerEntity playerIn,
                                                 Hand hand)

Called whenr the item stack is equipped and right clicked. Replaces the item stack with the return value.

onItemUseFinish

public ItemStack onItemUseFinish(World worldIn,
                                 LivingEntity entityLiving)

Called when the item in use count reach 0, e.g. item food eaten. Return the new ItemStack. Args : world, entity

write
```
public CompoundNBT write(CompoundNBT nbt)
```
Write the stack fields to a NBT object. Return the new NBT object.

getMaxStackSize
```
public int getMaxStackSize()
```
Returns maximum size of the stack.

isStackable
```
public boolean isStackable()
```
Returns true if the ItemStack can hold 2 or more units of the item.

isDamageable
```
public boolean isDamageable()
```
true if this itemStack is damageable

isDamaged
```
public boolean isDamaged()
```
returns true when a damageable item is damaged

getDamage
```
public int getDamage()
```

setDamage
```
public void setDamage(int damage)
```

getMaxDamage
```
public int getMaxDamage()
```
Returns the max damage an item in the stack can take.

attemptDamageItem
```
public boolean attemptDamageItem(int amount,
                                 java.util.Random rand,
                                 @Nullable
                                 ServerPlayerEntity damager)
```
Attempts to damage the ItemStack with par1 amount of damage, If the ItemStack has the Unbreaking enchantment there is a chance for each point of damage to be negated. Returns true if it takes more damage than getMaxDamage(). Returns false otherwise or if the ItemStack can't be damaged or if all points of damage are negated.

damageItem

public <T extends LivingEntity> void damageItem(int amount,
                                                T entityIn,
                                                java.util.function.Consumer<T> onBroken)

hitEntity
```
public void hitEntity(LivingEntity entityIn,
                      PlayerEntity playerIn)
```
Calls the delegated method to the Item to damage the incoming Entity, and if necessary, triggers a stats increase.

onBlockDestroyed

public void onBlockDestroyed(World worldIn,
                             BlockState blockIn,
                             BlockPos pos,
                             PlayerEntity playerIn)

Called when a Block is destroyed using this ItemStack

canHarvestBlock
```
public boolean canHarvestBlock(BlockState blockIn)
```
Check whether the given Block can be harvested using this ItemStack.

interactWithEntity

public boolean interactWithEntity(PlayerEntity playerIn,
                                  LivingEntity entityIn,
                                  Hand hand)

copy
```
public ItemStack copy()
```
Returns a new stack with the same properties.

areItemStackTagsEqual

public static boolean areItemStackTagsEqual(ItemStack stackA,
                                            ItemStack stackB)

areItemStacksEqual

public static boolean areItemStacksEqual(ItemStack stackA,
                                         ItemStack stackB)

compares ItemStack argument1 with ItemStack argument2; returns true if both ItemStacks are equal

areItemsEqual

public static boolean areItemsEqual(ItemStack stackA,
                                    ItemStack stackB)

Compares Item and damage value of the two stacks

areItemsEqualIgnoreDurability

public static boolean areItemsEqualIgnoreDurability(ItemStack stackA,
                                                    ItemStack stackB)

isItemEqual
```
public boolean isItemEqual(ItemStack other)
```
compares ItemStack argument to the instance ItemStack; returns true if the Items contained in both ItemStacks are equal

isItemEqualIgnoreDurability

public boolean isItemEqualIgnoreDurability(ItemStack stack)

getTranslationKey

public java.lang.String getTranslationKey()

toString
```
public java.lang.String toString()
```
オーバーライド:

toString クラス内 java.lang.Object

inventoryTick

public void inventoryTick(World worldIn,
                          Entity entityIn,
                          int inventorySlot,
                          boolean isCurrentItem)

Called each tick as long the ItemStack in on player inventory. Used to progress the pickup animation and update maps.

onCrafting

public void onCrafting(World worldIn,
                       PlayerEntity playerIn,
                       int amount)

getUseDuration
```
public int getUseDuration()
```

getUseAction
```
public UseAction getUseAction()
```

onPlayerStoppedUsing

public void onPlayerStoppedUsing(World worldIn,
                                 LivingEntity entityLiving,
                                 int timeLeft)

Called when the player releases the use item button.

isCrossbowStack
```
public boolean isCrossbowStack()
```

hasTag
```
public boolean hasTag()
```
Returns true if the ItemStack has an NBTTagCompound. Currently used to store enchantments.

getTag
```
@Nullable
public CompoundNBT getTag()
```

getOrCreateTag
```
public CompoundNBT getOrCreateTag()
```

getOrCreateChildTag

public CompoundNBT getOrCreateChildTag(java.lang.String key)

getChildTag

@Nullable
public CompoundNBT getChildTag(java.lang.String key)

Get an NBTTagCompound from this stack's NBT data.

removeChildTag

public void removeChildTag(java.lang.String p_196083_1_)

getEnchantmentTagList

public ListNBT getEnchantmentTagList()

setTag
```
public void setTag(@Nullable
                   CompoundNBT nbt)
```
Assigns a NBTTagCompound to the ItemStack, minecraft validates that only non-stackable items can have it.

getDisplayName

public ITextComponent getDisplayName()

setDisplayName

public ItemStack setDisplayName(@Nullable
                                ITextComponent name)

clearCustomName
```
public void clearCustomName()
```
Clear any custom name set for this ItemStack

hasDisplayName
```
public boolean hasDisplayName()
```
Returns true if the itemstack has a display name

getTooltip

public java.util.List<ITextComponent> getTooltip(@Nullable
                                                 PlayerEntity playerIn,
                                                 ITooltipFlag advanced)

Return a list of strings containing information about the item

addEnchantmentTooltips

public static void addEnchantmentTooltips(java.util.List<ITextComponent> p_222120_0_,
                                          ListNBT p_222120_1_)

hasEffect
```
public boolean hasEffect()
```

getRarity
```
public Rarity getRarity()
```

isEnchantable
```
public boolean isEnchantable()
```
True if it is a tool and has no enchantments to begin with

addEnchantment

public void addEnchantment(Enchantment ench,
                           int level)

Adds an enchantment with a desired level on the ItemStack.

isEnchanted
```
public boolean isEnchanted()
```
True if the item has enchantment data

setTagInfo

public void setTagInfo(java.lang.String key,
                       INBT value)

isOnItemFrame
```
public boolean isOnItemFrame()
```
Return whether this stack is on an item frame.

setItemFrame

public void setItemFrame(@Nullable
                         ItemFrameEntity frame)

Set the item frame this stack is on.

getItemFrame
```
@Nullable
public ItemFrameEntity getItemFrame()
```
Return the item frame this stack is on. Returns null if not on an item frame.

getRepairCost
```
public int getRepairCost()
```
Get this stack's repair cost, or 0 if no repair cost is defined.

setRepairCost
```
public void setRepairCost(int cost)
```
Set this stack's repair cost.

getAttributeModifiers

public com.google.common.collect.Multimap<java.lang.String,AttributeModifier> getAttributeModifiers(EquipmentSlotType equipmentSlot)

Gets the attribute modifiers for this ItemStack. Will check for an NBT tag list containing modifiers for the stack.

addAttributeModifier

public void addAttributeModifier(java.lang.String attributeName,
                                 AttributeModifier modifier,
                                 @Nullable
                                 EquipmentSlotType equipmentSlot)

getTextComponent
```
public ITextComponent getTextComponent()
```
Get a ChatComponent for this Item's display name that shows this Item on hover

canDestroy

public boolean canDestroy(NetworkTagManager p_206848_1_,
                          CachedBlockInfo p_206848_2_)

canPlaceOn

public boolean canPlaceOn(NetworkTagManager p_206847_1_,
                          CachedBlockInfo p_206847_2_)

getAnimationsToGo
```
public int getAnimationsToGo()
```

setAnimationsToGo

public void setAnimationsToGo(int animations)

getCount
```
public int getCount()
```

setCount
```
public void setCount(int count)
```

grow
```
public void grow(int count)
```

shrink
```
public void shrink(int count)
```

func_222121_b

public void func_222121_b(World worldIn,
                          LivingEntity livingEntityIn,
                          int countIn)

isFood
```
public boolean isFood()
```

deserializeNBT
```
public void deserializeNBT(CompoundNBT nbt)
```
定義:

deserializeNBT インタフェース内 INBTSerializable<CompoundNBT>

func_226629_F_
```
public SoundEvent func_226629_F_()
```

func_226630_G_
```
public SoundEvent func_226630_G_()
```

クラス ItemStack

フィールドのサマリー

コンストラクタのサマリー

メソッドのサマリー

クラスから継承されたメソッド net.minecraftforge.common.capabilities.CapabilityProvider

クラスから継承されたメソッド java.lang.Object

インタフェースから継承されたメソッド net.minecraftforge.common.extensions.IForgeItemStack

インタフェースから継承されたメソッド net.minecraftforge.common.capabilities.ICapabilityProvider

フィールドの詳細

EMPTY

DECIMALFORMAT

コンストラクタの詳細

ItemStack

ItemStack

ItemStack

メソッドの詳細

read

isEmpty

split

getItem

onItemUse

onItemUseFirst

getDestroySpeed

useItemRightClick

onItemUseFinish

write

getMaxStackSize

isStackable

isDamageable

isDamaged

getDamage

setDamage

getMaxDamage

attemptDamageItem

damageItem

hitEntity

onBlockDestroyed

canHarvestBlock

interactWithEntity

copy

areItemStackTagsEqual

areItemStacksEqual

areItemsEqual

areItemsEqualIgnoreDurability

isItemEqual

isItemEqualIgnoreDurability

getTranslationKey

toString

inventoryTick

onCrafting

getUseDuration

getUseAction

onPlayerStoppedUsing

isCrossbowStack

hasTag

getTag

getOrCreateTag

getOrCreateChildTag

getChildTag

removeChildTag

getEnchantmentTagList

setTag

getDisplayName

setDisplayName

clearCustomName

hasDisplayName

getTooltip

addEnchantmentTooltips

hasEffect

getRarity

isEnchantable

addEnchantment

isEnchanted

setTagInfo

isOnItemFrame

setItemFrame

getItemFrame

getRepairCost

setRepairCost

getAttributeModifiers