InventoryPlayer (Forge 1.11.2 API v13.20.1.2386 mappings snapshot

java.lang.Object
- net.minecraft.entity.player.InventoryPlayer

All Implemented Interfaces:: IInventory, IWorldNameable

public class InventoryPlayer
extends java.lang.Object
implements IInventory

Field Summary

Fields
Modifier and Type	Field and Description
`NonNullList<ItemStack>`	`armorInventory` An array of 4 item stacks containing the currently worn armor pieces.
`int`	`currentItem` The index of the currently held item (0-8).
`boolean`	`inventoryChanged` Set true whenever the inventory changes.
`NonNullList<ItemStack>`	`mainInventory` An array of 36 item stacks indicating the main player inventory (including the visible bar).
`NonNullList<ItemStack>`	`offHandInventory`
`EntityPlayer`	`player` The player whose inventory this is.

Constructor Summary

Constructors
Constructor and Description

InventoryPlayer(EntityPlayer playerIn)

Constructors
Constructor and Description
`InventoryPlayer(EntityPlayer playerIn)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`addItemStackToInventory(ItemStack itemStackIn)` Adds the item stack to the inventory, returns false if it is impossible.
`ItemStack`	`armorItemInSlot(int slotIn)` returns a player armor item (as itemstack) contained in specified armor slot.
`boolean`	`canHarvestBlock(IBlockState state)`
`void`	`changeCurrentItem(int direction)` Switch the current item to the next one or the previous one
`void`	`clear()`
`int`	`clearMatchingItems(Item itemIn, int metadataIn, int removeCount, NBTTagCompound itemNBT)` Removes matching items from the inventory.
`void`	`closeInventory(EntityPlayer player)`
`void`	`copyInventory(InventoryPlayer playerInventory)` Copy the ItemStack contents from another InventoryPlayer instance
`void`	`damageArmor(float damage)` Damages armor in each slot by the specified amount.
`void`	`decrementAnimations()` Decrement the number of animations remaining.
`ItemStack`	`decrStackSize(int index, int count)` Removes up to a specified number of items from an inventory slot and returns them in a new stack.
`void`	`deleteStack(ItemStack stack)`
`void`	`dropAllItems()` Drop all armor and main inventory items.
`int`	`getBestHotbarSlot()`
`ItemStack`	`getCurrentItem()` Returns the item stack currently held by the player.
`ITextComponent`	`getDisplayName()` Get the formatted ChatComponent that will be used for the sender's username in chat
`int`	`getField(int id)`
`int`	`getFieldCount()`
`int`	`getFirstEmptyStack()` Returns the first item stack that is empty.
`static int`	`getHotbarSize()` Get the size of the player hotbar inventory
`int`	`getInventoryStackLimit()` Returns the maximum stack size for a inventory slot.
`ItemStack`	`getItemStack()` Stack helds by mouse, used in GUI and Containers
`java.lang.String`	`getName()` Get the name of this object.
`int`	`getSizeInventory()` Returns the number of slots in the inventory.
`int`	`getSlotFor(ItemStack stack)` Finds the stack or an equivalent one in the main inventory
`ItemStack`	`getStackInSlot(int index)` Returns the stack in the given slot.
`float`	`getStrVsBlock(IBlockState state)`
`boolean`	`hasCustomName()` Returns true if this thing is named
`boolean`	`hasItemStack(ItemStack itemStackIn)` Returns true if the specified ItemStack exists in the inventory.
`boolean`	`isEmpty()`
`static boolean`	`isHotbar(int index)`
`boolean`	`isItemValidForSlot(int index, ItemStack stack)` Returns true if automation is allowed to insert the given stack (ignoring stack size) into the given slot.
`boolean`	`isUsableByPlayer(EntityPlayer player)` Don't rename this method to canInteractWith due to conflicts with Container
`void`	`markDirty()` For tile entities, ensures the chunk containing the tile entity is saved to disk later - the game won't think it hasn't changed and skip it.
`void`	`openInventory(EntityPlayer player)`
`void`	`pickItem(int index)`
`void`	`readFromNBT(NBTTagList nbtTagListIn)` Reads from the given tag list and fills the slots in the inventory with the correct items.
`ItemStack`	`removeStackFromSlot(int index)` Removes a stack from the given slot and returns it.
`void`	`setField(int id, int value)`
`void`	`setInventorySlotContents(int index, ItemStack stack)` Sets the given item stack to the specified slot in the inventory (can be crafting or armor sections).
`void`	`setItemStack(ItemStack itemStackIn)` Set the stack helds by mouse, used in GUI/Container
`void`	`setPickedItemStack(ItemStack stack)`
`NBTTagList`	`writeToNBT(NBTTagList nbtTagListIn)` Writes the inventory out as a list of compound tags.

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

- Field Detail
  - mainInventory
```
public final NonNullList<ItemStack> mainInventory
```
    An array of 36 item stacks indicating the main player inventory (including the visible bar).
  - armorInventory
```
public final NonNullList<ItemStack> armorInventory
```
    An array of 4 item stacks containing the currently worn armor pieces.
  - offHandInventory
```
public final NonNullList<ItemStack> offHandInventory
```
  - currentItem
```
public int currentItem
```
    The index of the currently held item (0-8).
  - player
```
public EntityPlayer player
```
    The player whose inventory this is.
  - inventoryChanged
```
public boolean inventoryChanged
```
    Set true whenever the inventory changes. Nothing sets it false so you will have to write your own code to check it and reset the value.
- Constructor Detail
  - InventoryPlayer
```
public InventoryPlayer(EntityPlayer playerIn)
```
- Method Detail
  - getCurrentItem
```
public ItemStack getCurrentItem()
```
    Returns the item stack currently held by the player.
  - getHotbarSize
```
public static int getHotbarSize()
```
    Get the size of the player hotbar inventory
  - getFirstEmptyStack
```
public int getFirstEmptyStack()
```
    Returns the first item stack that is empty.
  - setPickedItemStack
```
public void setPickedItemStack(ItemStack stack)
```
  - pickItem
```
public void pickItem(int index)
```
  - isHotbar
```
public static boolean isHotbar(int index)
```
  - getSlotFor
```
public int getSlotFor(ItemStack stack)
```
    Finds the stack or an equivalent one in the main inventory
  - getBestHotbarSlot
```
public int getBestHotbarSlot()
```
  - changeCurrentItem
```
public void changeCurrentItem(int direction)
```
    Switch the current item to the next one or the previous one
  - clearMatchingItems
```
public int clearMatchingItems(Item itemIn,
                              int metadataIn,
                              int removeCount,
                              NBTTagCompound itemNBT)
```
    Removes matching items from the inventory.
    
    Parameters:
    
    itemIn - The item to match, null ignores.
    
    metadataIn - The metadata to match, -1 ignores.
    
    removeCount - The number of items to remove. If less than 1, removes all matching items.
    
    itemNBT - The NBT data to match, null ignores.
    
    Returns:
    
    The number of items removed from the inventory.
  - decrementAnimations
```
public void decrementAnimations()
```
    Decrement the number of animations remaining. Only called on client side. This is used to handle the animation of receiving a block.
  - addItemStackToInventory
```
public boolean addItemStackToInventory(ItemStack itemStackIn)
```
    Adds the item stack to the inventory, returns false if it is impossible.
  - decrStackSize
```
public ItemStack decrStackSize(int index,
                               int count)
```
    Removes up to a specified number of items from an inventory slot and returns them in a new stack.
    
    Specified by:
    
    decrStackSize in interface IInventory
  - deleteStack
```
public void deleteStack(ItemStack stack)
```
  - removeStackFromSlot
```
public ItemStack removeStackFromSlot(int index)
```
    Removes a stack from the given slot and returns it.
    
    Specified by:
    
    removeStackFromSlot in interface IInventory
  - setInventorySlotContents
```
public void setInventorySlotContents(int index,
                                     ItemStack stack)
```
    Sets the given item stack to the specified slot in the inventory (can be crafting or armor sections).
    
    Specified by:
    
    setInventorySlotContents in interface IInventory
  - getStrVsBlock
```
public float getStrVsBlock(IBlockState state)
```
  - writeToNBT
```
public NBTTagList writeToNBT(NBTTagList nbtTagListIn)
```
    Writes the inventory out as a list of compound tags. This is where the slot indices are used (+100 for armor, +80 for crafting).
  - readFromNBT
```
public void readFromNBT(NBTTagList nbtTagListIn)
```
    Reads from the given tag list and fills the slots in the inventory with the correct items.
  - getSizeInventory
```
public int getSizeInventory()
```
    Returns the number of slots in the inventory.
    
    Specified by:
    
    getSizeInventory in interface IInventory
  - isEmpty
```
public boolean isEmpty()
```
    Specified by:
    
    isEmpty in interface IInventory
  - getStackInSlot
```
public ItemStack getStackInSlot(int index)
```
    Returns the stack in the given slot.
    
    Specified by:
    
    getStackInSlot in interface IInventory
  - getName
```
public java.lang.String getName()
```
    Get the name of this object. For players this returns their username
    
    Specified by:
    
    getName in interface IWorldNameable
  - hasCustomName
```
public boolean hasCustomName()
```
    Returns true if this thing is named
    
    Specified by:
    
    hasCustomName in interface IWorldNameable
  - getDisplayName
```
public ITextComponent getDisplayName()
```
    Get the formatted ChatComponent that will be used for the sender's username in chat
    
    Specified by:
    
    getDisplayName in interface IWorldNameable
  - getInventoryStackLimit
```
public int getInventoryStackLimit()
```
    Returns the maximum stack size for a inventory slot. Seems to always be 64, possibly will be extended.
    
    Specified by:
    
    getInventoryStackLimit in interface IInventory
  - canHarvestBlock
```
public boolean canHarvestBlock(IBlockState state)
```
  - armorItemInSlot
```
public ItemStack armorItemInSlot(int slotIn)
```
    returns a player armor item (as itemstack) contained in specified armor slot.
  - damageArmor
```
public void damageArmor(float damage)
```
    Damages armor in each slot by the specified amount.
  - dropAllItems
```
public void dropAllItems()
```
    Drop all armor and main inventory items.
  - markDirty
```
public void markDirty()
```
    For tile entities, ensures the chunk containing the tile entity is saved to disk later - the game won't think it hasn't changed and skip it.
    
    Specified by:
    
    markDirty in interface IInventory
  - setItemStack
```
public void setItemStack(ItemStack itemStackIn)
```
    Set the stack helds by mouse, used in GUI/Container
  - getItemStack
```
public ItemStack getItemStack()
```
    Stack helds by mouse, used in GUI and Containers
  - isUsableByPlayer
```
public boolean isUsableByPlayer(EntityPlayer player)
```
    Don't rename this method to canInteractWith due to conflicts with Container
    
    Specified by:
    
    isUsableByPlayer in interface IInventory
  - hasItemStack
```
public boolean hasItemStack(ItemStack itemStackIn)
```
    Returns true if the specified ItemStack exists in the inventory.
  - openInventory
```
public void openInventory(EntityPlayer player)
```
    Specified by:
    
    openInventory in interface IInventory
  - closeInventory
```
public void closeInventory(EntityPlayer player)
```
    Specified by:
    
    closeInventory in interface IInventory
  - isItemValidForSlot
```
public boolean isItemValidForSlot(int index,
                                  ItemStack stack)
```
    Returns true if automation is allowed to insert the given stack (ignoring stack size) into the given slot. For guis use Slot.isItemValid
    
    Specified by:
    
    isItemValidForSlot in interface IInventory
  - copyInventory
```
public void copyInventory(InventoryPlayer playerInventory)
```
    Copy the ItemStack contents from another InventoryPlayer instance
  - getField
```
public int getField(int id)
```
    Specified by:
    
    getField in interface IInventory
  - setField
```
public void setField(int id,
                     int value)
```
    Specified by:
    
    setField in interface IInventory
  - getFieldCount
```
public int getFieldCount()
```
    Specified by:
    
    getFieldCount in interface IInventory
  - clear
```
public void clear()
```
    Specified by:
    
    clear in interface IInventory

Class InventoryPlayer

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

mainInventory

armorInventory

offHandInventory

currentItem

player

inventoryChanged

Constructor Detail

InventoryPlayer

Method Detail

getCurrentItem

getHotbarSize

getFirstEmptyStack

setPickedItemStack

pickItem

isHotbar

getSlotFor

getBestHotbarSlot

changeCurrentItem

clearMatchingItems

decrementAnimations

addItemStackToInventory

decrStackSize

deleteStack

removeStackFromSlot

setInventorySlotContents

getStrVsBlock

writeToNBT

readFromNBT

getSizeInventory

isEmpty

getStackInSlot

getName

hasCustomName

getDisplayName

getInventoryStackLimit

canHarvestBlock

armorItemInSlot

damageArmor

dropAllItems

markDirty

setItemStack

getItemStack

isUsableByPlayer

hasItemStack

openInventory

closeInventory

isItemValidForSlot

copyInventory

getField

setField

getFieldCount

clear