nova.core.component.inventory

Interface Inventory

All Superinterfaces:

java.lang.Iterable<Item>

All Known Subinterfaces:

InventoryPlayer

All Known Implementing Classes:

InventorySimple, InventoryView

public interface Inventory
extends java.lang.Iterable<Item>

This interface provides inventory that can hold Items

See Also:

InventorySimple, InventoryView

Method Summary

Modifier and Type	Method and Description
default int	add(int slot, Item stack) Adds items to this inventory at specified slot
default int	add(Item stack) Adds items to this inventory
java.util.Optional<Item>	get(int slot)
default java.util.Iterator<Item>	iterator()
void	markChanged() Tells this inventory that something has changed
java.util.Optional<Item>	remove(int slot) Removes a one count of the item from a slot.
default java.util.Optional<Item>	remove(int slot, int amount) Removes a certain amount of items from a slot.
default java.util.Optional<Item>	remove(Item check) Removes a certain item from a slot.
boolean	set(int slot, Item stack) Sets Item in slot
int	size() Gets count of slots
default java.util.Spliterator<Item>	spliterator()
default java.util.stream.Stream<Item>	stream() Represents this inventory as Item Stream
default java.util.List<Item>	toList() Represents this inventory as list of Items
default java.util.Set<Item>	toSet()

Methods inherited from interface java.lang.Iterable

forEach

Method Detail

get

java.util.Optional<Item> get(int slot)

set

boolean set(int slot,
            Item stack)

Sets Item in slot

Parameters:

slot - Slot number

stack - Stack to insert

Returns:

Whether succeed

size

int size()

Gets count of slots

Returns:

Number of slots in this inventory

markChanged

void markChanged()

Tells this inventory that something has changed

add

default int add(int slot,
                Item stack)

Adds items to this inventory at specified slot

Parameters:

slot - Slot to add items into

stack - Item containing items

Returns:

Amount of items left(did not fit inside this inventory)

add

default int add(Item stack)

Adds items to this inventory

Parameters:

stack - Item containing items

Returns:

Amount of items left(did not fit inside this inventory)

remove

java.util.Optional<Item> remove(int slot)

Removes a one count of the item from a slot.

Parameters:

slot - The slot index to remove

Returns:

The items removed

remove

default java.util.Optional<Item> remove(int slot,
                                        int amount)

Removes a certain amount of items from a slot.

Parameters:

slot - The slot index to remove

amount - The amount of items to remove

Returns:

The items removed

remove

default java.util.Optional<Item> remove(Item check)

Removes a certain item from a slot.

Parameters:

check - The item type to check with

Returns:

The items removed

toList

default java.util.List<Item> toList()

Represents this inventory as list of Items

Returns:

This inventory as list of Items

toSet

default java.util.Set<Item> toSet()

iterator

default java.util.Iterator<Item> iterator()

Specified by:

iterator in interface java.lang.Iterable<Item>

spliterator

default java.util.Spliterator<Item> spliterator()

Specified by:

spliterator in interface java.lang.Iterable<Item>

stream

default java.util.stream.Stream<Item> stream()

Represents this inventory as Item Stream

Returns:

This inventory as Item Stream