tutorial:inventory
Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revisionNext revisionBoth sides next revision | ||
tutorial:inventory [2020/07/16 23:54] – update activate references to onUse user11681 | tutorial:inventory [2020/10/15 19:50] – [Implementing Inventory] Changed "canPlayerUseInv(..." to "canPlayerUse(..." to reflect current mappings nshak | ||
---|---|---|---|
Line 17: | Line 17: | ||
*/ | */ | ||
public interface ImplementedInventory extends Inventory { | public interface ImplementedInventory extends Inventory { | ||
+ | |||
/** | /** | ||
- | | + | |
* Must return the same instance every time it's called. | * Must return the same instance every time it's called. | ||
*/ | */ | ||
DefaultedList< | DefaultedList< | ||
- | | + | |
/** | /** | ||
* Creates an inventory from the item list. | * Creates an inventory from the item list. | ||
Line 29: | Line 30: | ||
return () -> items; | return () -> items; | ||
} | } | ||
+ | | ||
/** | /** | ||
- | * Creates a new inventory with the size. | + | * Creates a new inventory with the specified |
*/ | */ | ||
static ImplementedInventory ofSize(int size) { | static ImplementedInventory ofSize(int size) { | ||
return of(DefaultedList.ofSize(size, | return of(DefaultedList.ofSize(size, | ||
} | } | ||
- | | + | |
/** | /** | ||
* Returns the inventory size. | * Returns the inventory size. | ||
*/ | */ | ||
@Override | @Override | ||
- | default int getInvSize() { | + | default int size() { |
return getItems().size(); | return getItems().size(); | ||
} | } | ||
+ | | ||
/** | /** | ||
- | * @return true if this inventory has only empty stacks, false otherwise | + | * Checks if the inventory is empty. |
+ | * @return true if this inventory has only empty stacks, false otherwise. | ||
*/ | */ | ||
@Override | @Override | ||
- | default boolean | + | default boolean |
- | for (int i = 0; i < getInvSize(); i++) { | + | for (int i = 0; i < size(); i++) { |
- | ItemStack stack = getInvStack(i); | + | ItemStack stack = getStack(i); |
if (!stack.isEmpty()) { | if (!stack.isEmpty()) { | ||
return false; | return false; | ||
Line 56: | Line 60: | ||
return true; | return true; | ||
} | } | ||
+ | | ||
/** | /** | ||
- | | + | |
*/ | */ | ||
@Override | @Override | ||
- | default ItemStack | + | default ItemStack |
return getItems().get(slot); | return getItems().get(slot); | ||
} | } | ||
+ | | ||
/** | /** | ||
- | | + | |
- | | + | |
- | * takes all items in that slot. | + | * @param count How many items to remove. |
+ | | ||
*/ | */ | ||
@Override | @Override | ||
- | default ItemStack | + | default ItemStack |
ItemStack result = Inventories.splitStack(getItems(), | ItemStack result = Inventories.splitStack(getItems(), | ||
if (!result.isEmpty()) { | if (!result.isEmpty()) { | ||
Line 76: | Line 83: | ||
return result; | return result; | ||
} | } | ||
+ | | ||
/** | /** | ||
- | * Removes | + | * Removes |
+ | | ||
*/ | */ | ||
@Override | @Override | ||
- | default ItemStack | + | default ItemStack |
return Inventories.removeStack(getItems(), | return Inventories.removeStack(getItems(), | ||
} | } | ||
+ | | ||
/** | /** | ||
- | * Replaces the current stack in the {@code | + | * Replaces the current stack in an inventory |
- | | + | |
- | * it gets resized to this inventory' | + | * @param stack The replacing itemstack. |
+ | | ||
+ | | ||
*/ | */ | ||
@Override | @Override | ||
- | default void setInvStack(int slot, ItemStack stack) { | + | default void setStack(int slot, ItemStack stack) { |
getItems().set(slot, | getItems().set(slot, | ||
- | if (stack.getCount() > getInvMaxStackAmount()) { | + | if (stack.getCount() > getMaxCountPerStack()) { |
- | stack.setCount(getInvMaxStackAmount()); | + | stack.setCount(getMaxCountPerStack()); |
} | } | ||
} | } | ||
+ | | ||
/** | /** | ||
- | * Clears | + | * Clears the inventory. |
*/ | */ | ||
@Override | @Override | ||
Line 102: | Line 115: | ||
getItems().clear(); | getItems().clear(); | ||
} | } | ||
+ | | ||
+ | /** | ||
+ | * Marks the state as dirty. | ||
+ | * Must be called after changes in the inventory, so that the game can properly save | ||
+ | * the inventory contents and notify neighboring blocks of inventory changes. | ||
+ | | ||
@Override | @Override | ||
default void markDirty() { | default void markDirty() { | ||
// Override if you want behavior. | // Override if you want behavior. | ||
} | } | ||
+ | | ||
+ | /** | ||
+ | * @return true if the player can use the inventory, false otherwise. | ||
+ | | ||
@Override | @Override | ||
- | default boolean | + | default boolean |
return true; | return true; | ||
} | } |
tutorial/inventory.txt · Last modified: 2023/11/06 23:28 by binaris00