OpenSource/PaperMC
OpenSource/PaperMC
1
0
Fork 0
mirror of https://github.com/PaperMC/Paper.git synced 2025-01-09 03:43:40 +01:00
Code Issues Projects Releases Packages Wiki Activity

SPIGOT-1526 / SPIGOT-1809: Expand Inventory API

Browse source 
By: md_5 <git@md-5.net>
This commit is contained in:
Bukkit/Spigot 2016-03-07 17:20:01 +11:00
parent b45872f434
commit b10b2605b1
2 changed files with 43 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

22
paper-api/src/main/java/org/bukkit/inventory/Inventory.java
View file

@ -127,6 +127,28 @@ public interface Inventory extends Iterable<ItemStack> {
*/
public void setContents(ItemStack[] items) throws IllegalArgumentException;
/**
* Return the contents from the section of the inventory where items can
* reasonably be expected to be stored. In most cases this will represent
* the entire inventory, but in some cases it may exclude armor or result
* slots.
* <br>
* It is these contents which will be used for add / contains / remove
* methods which look for a specific stack.
*
* @return inventory storage contents
*/
public ItemStack[] getStorageContents();
/**
* Put the given ItemStacks into the storage slots
*
* @param items The ItemStacks to use as storage contents
* @throws IllegalArgumentException If the array has more items than the
* inventory.
*/
public void setStorageContents(ItemStack[] items) throws IllegalArgumentException;
/**
* Checks if the inventory contains any ItemStacks with the given
* materialId

22
paper-api/src/main/java/org/bukkit/inventory/PlayerInventory.java
View file

@ -3,7 +3,7 @@ package org.bukkit.inventory;
import org.bukkit.entity.HumanEntity;
/**
* Interface to the inventory of a Player, including the four armor slots.
* Interface to the inventory of a Player, including the four armor slots and any extra slots.
*/
public interface PlayerInventory extends Inventory {
@ -14,6 +14,17 @@ public interface PlayerInventory extends Inventory {
*/
public ItemStack[] getArmorContents();
/**
* Get all additional ItemStacks stored in this inventory.
* <br>
* NB: What defines an extra slot is up to the implementation, however it
* will not be contained within {@link #getStorageContents()} or
* {@link #getArmorContents()}
*
* @return All additional ItemStacks
*/
public ItemStack[] getExtraContents();
/**
* Return the ItemStack from the helmet slot
*
@ -73,6 +84,15 @@ public interface PlayerInventory extends Inventory {
*/
public void setArmorContents(ItemStack[] items);
/**
* Put the given ItemStacks into the extra slots
* <br>
* See {@link #getExtraContents()} for an explanation of extra slots.
*
* @param items The ItemStacks to use as extra
*/
public void setExtraContents(ItemStack[] items);
/**
* Put the given ItemStack into the helmet slot. This does not check if
* the ItemStack is a helmet