io.github.portlek.smartinventory

Interface InventoryContents

All Known Implementing Classes:

BasicInventoryContents

public interface InventoryContents

represents the content of an inventory.

this contains several methods which let you get and modify the content of the inventory.

for example, you can get the item at a given slot by using get(SlotPos). You can also fill an entire column with the use of the method fillColumn(int, Icon).

Method Summary

Modifier and Type	Method and Description
default @NotNull InventoryContents	add(@NotNull Icon item) adds an item to the first empty slot of the inventory.
@NotNull Icon[][]	all() returns a 2D array of Icon containing all the items of the inventory.
default @NotNull InventoryContents	applyRect(int fromRow, int fromColumn, int toRow, int toColumn, @NotNull Consumer<Icon> apply) applies the consumer on a rectangle inside the inventory using the given positions.
default @NotNull InventoryContents	applyRect(int fromRow, int fromColumn, int toRow, int toColumn, @NotNull ObjIntConsumer<Integer> apply) applie the consumer on a rectangle inside the inventory using the given positions.
default @NotNull InventoryContents	fill(@NotNull Icon item) fills the inventory with the given item.
default @NotNull InventoryContents	fillBorders(@NotNull Icon item) fills the inventory borders with the given item.
default @NotNull InventoryContents	fillColumn(int column, @NotNull Icon item) fills the given inventory column with the given item.
default @NotNull InventoryContents	fillEmpties(@NotNull Icon item) fills the empty slots of the inventory with the given item.
default @NotNull InventoryContents	fillPattern(@NotNull Pattern<Icon> pattern) fills the inventory with the given Pattern.
default @NotNull InventoryContents	fillPattern(@NotNull Pattern<Icon> pattern, int startIndex) fills the inventory with the given Pattern.
default @NotNull InventoryContents	fillPattern(@NotNull Pattern<Icon> pattern, int startRow, int startColumn) fills the inventory with the given Pattern.
default @NotNull InventoryContents	fillPattern(@NotNull Pattern<Icon> pattern, @NotNull SlotPos startPos) fills the inventory with the given Pattern.
default @NotNull InventoryContents	fillPatternRepeating(@NotNull Pattern<Icon> pattern) fills the inventory with the given Pattern.
default @NotNull InventoryContents	fillPatternRepeating(@NotNull Pattern<Icon> pattern, int startIndex, int endIndex) fills the inventory with the given Pattern.
default @NotNull InventoryContents	fillPatternRepeating(@NotNull Pattern<Icon> pattern, int startRow, int startColumn, int endRow, int endColumn) fills the inventory with the given Pattern.
default @NotNull InventoryContents	fillPatternRepeating(@NotNull Pattern<Icon> pattern, @NotNull SlotPos startPos, @NotNull SlotPos endPos) fills the inventory with the given Pattern.
default @NotNull InventoryContents	fillRect(int fromIndex, int toIndex, @NotNull Icon item) fills a rectangle inside the inventory using the given positions.
default @NotNull InventoryContents	fillRect(int fromRow, int fromColumn, int toRow, int toColumn, @NotNull Icon item) same as fillRect(int, int, Icon), but with SlotPos instead of the indexes.
default @NotNull InventoryContents	fillRect(@NotNull SlotPos fromPos, @NotNull SlotPos toPos, @NotNull Icon item) same as fillRect(int, int, Icon), but with rows and columns instead of the indexes.
default @NotNull InventoryContents	fillRow(int row, @NotNull Icon item) fills the given inventory row with the given item.
default @NotNull InventoryContents	fillSquare(int fromIndex, int toIndex, @NotNull Icon item) completely fills the provided square with the given Icon.
default @NotNull InventoryContents	fillSquare(int fromRow, int fromColumn, int toRow, int toColumn, @NotNull Icon item) completely fills the provided square with the given Icon.
default @NotNull InventoryContents	fillSquare(@NotNull SlotPos fromPos, @NotNull SlotPos toPos, @NotNull Icon item) completely fills the provided square with the given Icon.
default @NotNull Optional<SlotPos>	findItem(@NotNull Icon item) looks for the given icon and compares them using ItemStack.isSimilar(ItemStack), ignoring the amount.
default @NotNull Optional<SlotPos>	findItem(@NotNull org.bukkit.inventory.ItemStack item) looks for the given item and compares them using ItemStack.isSimilar(ItemStack), ignoring the amount.
default @NotNull Optional<SlotPos>	firstEmpty() returns the position of the first empty slot in the inventory, or Optional.empty() if there is no free slot.
default @NotNull Optional<Icon>	get(int index) returns the item in the inventory at the given slot index, or Optional.empty() if the slot is empty or if the index is out of bounds.
default @NotNull Optional<Icon>	get(int row, int column) same as get(int), but with a row and a column instead of the index.
default @NotNull Optional<Icon>	get(@NotNull SlotPos slotPos) same as get(int), but with a SlotPos instead of the index.
default @NotNull org.bukkit.inventory.Inventory	getBottomInventory() gets player's bottom of the inventory.
<T> T	getProperty(@NotNull String name) gets the value of the property with the given name.
<T> T	getPropertyOrDefault(@NotNull String name, T def) gets the value of the property with the given name, or a default value if the property isn't set.
default @NotNull org.bukkit.inventory.Inventory	getTopInventory() gets player's top of the inventory.
boolean	isEditable(@NotNull SlotPos slot) returns if a given slot is editable or not.
@NotNull Optional<SlotIterator>	iterator(@NotNull String id) gets a previously registered iterator named with the given id.
default @NotNull SlotIterator	newIterator(SlotIterator.Type type, int startRow, int startColumn) creates and returns an iterator.
default @NotNull SlotIterator	newIterator(SlotIterator.Type type, @NotNull SlotPos startPos) same as newIterator(SlotIterator.Type, int, int), but using a SlotPos instead.
@NotNull SlotIterator	newIterator(@NotNull String id, SlotIterator.Type type, int startRow, int startColumn) creates and registers an iterator using a given id.
default @NotNull SlotIterator	newIterator(@NotNull String id, SlotIterator.Type type, @NotNull SlotPos startPos) same as newIterator(String, SlotIterator.Type, int, int), but using a SlotPos instead.
default void	notifyUpdate() runs Page.notifyUpdate(InventoryContents) method of this.
default void	notifyUpdateForAll() runs Page.notifyUpdateForAll() method of this.
default void	notifyUpdateForAllById() runs Page.notifyUpdateForAllById() method of this.
default void	openNext() opens the next page with using Pagination.
default void	openPrevious() opens the previous page with using Pagination.
@NotNull Page	page() obtains the page of the this.
@NotNull Pagination	pagination() gets the pagination system linked to this.
@NotNull org.bukkit.entity.Player	player() obtains the player of the contents.
default void	removeAll(@NotNull Icon item) removes all occurrences of the item from the inventory.
default void	removeAll(@NotNull org.bukkit.inventory.ItemStack item) removes all occurrences of the item from the inventory.
default void	removeAmount(@NotNull Icon item, int amount) removes the specified amount of items from the inventory.
default void	removeAmount(@NotNull org.bukkit.inventory.ItemStack item, int amount) removes the specified amount of items from the inventory.
default void	removeFirst(@NotNull Icon item) clears the first slot where the given item is in.
default void	removeFirst(@NotNull org.bukkit.inventory.ItemStack item) clears the first slot where the given item is in.
default void	reopen() re open the current page.
default @NotNull InventoryContents	set(int index, @Nullable Icon item) sets the item in the inventory at the given slot index.
@NotNull InventoryContents	set(int row, int column, @Nullable Icon item) same as set(int, Icon), but with a row and a column instead of the index.
default @NotNull InventoryContents	set(@NotNull SlotPos slotPos, @Nullable Icon item) Same as set(int, Icon), but with a SlotPos instead of the index.
default InventoryContents	setEditable(@NotNull SlotPos slot) makes a slot editable, which enables the player to put items in and take items out of the inventory in the specified slot.
InventoryContents	setEditable(@NotNull SlotPos slot, boolean editable) makes a slot editable, which enables the player to put items in and take items out of the inventory in the specified slot.
@NotNull InventoryContents	setProperty(@NotNull String name, @NotNull Object value) sets the value of the property with the given name.
default @NotNull List<SlotPos>	slots() returns a list of all the slots in the inventory.

Method Detail

newIterator

@NotNull
default @NotNull SlotIterator newIterator(@NotNull
                                                   SlotIterator.Type type,
                                                   int startRow,
                                                   int startColumn)

creates and returns an iterator.

this does NOT registers the iterator, thus iterator(String) will not be able to return the iterators created with this method.

Parameters:

type - the type of the iterator.

startRow - the starting row of the iterator.

startColumn - the starting column of the iterator.

Returns:

the newly created iterator.

newIterator

@NotNull
default @NotNull SlotIterator newIterator(@NotNull
                                                   @NotNull String id,
                                                   @NotNull
                                                   SlotIterator.Type type,
                                                   @NotNull
                                                   @NotNull SlotPos startPos)

same as newIterator(String, SlotIterator.Type, int, int), but using a SlotPos instead.

Parameters:

id - the id of the iterator.

type - the type of the iterator.

startPos - the starting position of the iterator.

Returns:

the newly created iterator.

newIterator

@NotNull
default @NotNull SlotIterator newIterator(@NotNull
                                                   SlotIterator.Type type,
                                                   @NotNull
                                                   @NotNull SlotPos startPos)

same as newIterator(SlotIterator.Type, int, int), but using a SlotPos instead.

Parameters:

type - the type of the iterator.

startPos - the starting position of the iterator.

Returns:

the newly created iterator.

slots

@NotNull
default @NotNull List<SlotPos> slots()

returns a list of all the slots in the inventory.

Returns:

the inventory slots.

firstEmpty

@NotNull
default @NotNull Optional<SlotPos> firstEmpty()

returns the position of the first empty slot in the inventory, or Optional.empty() if there is no free slot.

Returns:

the first empty slot, if there is one.

get

@NotNull
default @NotNull Optional<Icon> get(int index)

returns the item in the inventory at the given slot index, or Optional.empty() if the slot is empty or if the index is out of bounds.

Parameters:

index - the slot index.

Returns:

the found item, if there is one.

get

@NotNull
default @NotNull Optional<Icon> get(int row,
                                             int column)

same as get(int), but with a row and a column instead of the index.

Parameters:

row - the row to get.

column - the colum to get.

Returns:

the found item, if there is one.

get

@NotNull
default @NotNull Optional<Icon> get(@NotNull
                                             @NotNull SlotPos slotPos)

same as get(int), but with a SlotPos instead of the index.

Parameters:

slotPos - the slot position to get.

Returns:

the found item, if there is one.

applyRect

@NotNull
default @NotNull InventoryContents applyRect(int fromRow,
                                                      int fromColumn,
                                                      int toRow,
                                                      int toColumn,
                                                      @NotNull
                                                      @NotNull ObjIntConsumer<Integer> apply)

applie the consumer on a rectangle inside the inventory using the given positions.

the created rectangle will have its top-left position at the given from slot index and its bottom-right position at the given to slot index.

Parameters:

fromColumn - the from column to apply.

fromRow - the from row to apply.

toColumn - the to column to apply.

toRow - the to row to apply.

apply - the apply to accept row and column

Returns:

this, for chained calls

applyRect

@NotNull
default @NotNull InventoryContents applyRect(int fromRow,
                                                      int fromColumn,
                                                      int toRow,
                                                      int toColumn,
                                                      @NotNull
                                                      @NotNull Consumer<Icon> apply)

applies the consumer on a rectangle inside the inventory using the given positions. applies only when the Icon exist in this GUI.

the created rectangle will have its top-left position at the given from slot index and its bottom-right position at the given to slot index.

Parameters:

fromColumn - the from column to apply.

fromRow - the from row to apply.

toColumn - the to column to apply.

toRow - the to row to apply.

apply - the apply to accept each slot

Returns:

this, for chained calls

set

@NotNull
default @NotNull InventoryContents set(int index,
                                                @Nullable
                                                @Nullable Icon item)

sets the item in the inventory at the given slot index.

Parameters:

index - the slot index.

item - the item to set, or null to clear the slot

Returns:

this, for chained calls.

set

@NotNull
default @NotNull InventoryContents set(@NotNull
                                                @NotNull SlotPos slotPos,
                                                @Nullable
                                                @Nullable Icon item)

Same as set(int, Icon), but with a SlotPos instead of the index.

Parameters:

slotPos - the slotPos to set.

item - the item to set.

Returns:

this, for chained calls.

add

@NotNull
default @NotNull InventoryContents add(@NotNull
                                                @NotNull Icon item)

adds an item to the first empty slot of the inventory. Warning: if there is already a stack of the same item, this will not add the item to the stack, this will always add the item into an empty slot.

Parameters:

item - the item to add.

Returns:

this, for chained calls.

findItem

@NotNull
default @NotNull Optional<SlotPos> findItem(@NotNull
                                                     @NotNull org.bukkit.inventory.ItemStack item)

looks for the given item and compares them using ItemStack.isSimilar(ItemStack), ignoring the amount.

this method searches row for row from left to right.

Parameters:

item - the item to look for.

Returns:

an optional containing the position where the item first occurred, or an empty optional.

findItem

@NotNull
default @NotNull Optional<SlotPos> findItem(@NotNull
                                                     @NotNull Icon item)

looks for the given icon and compares them using ItemStack.isSimilar(ItemStack), ignoring the amount.

this method searches row for row from left to right.

Parameters:

item - the item with the item stack to look for.

Returns:

an optional containing the position where the item first occurred, or an empty optional.

removeFirst

default void removeFirst(@NotNull
                         @NotNull org.bukkit.inventory.ItemStack item)

clears the first slot where the given item is in.

the items will be compared using ItemStack.isSimilar(ItemStack) to check if the are equal.

the amount stored in the item is ignored for simplicity.

Parameters:

item - the item as an ItemStack that shall be removed from the inventory.

removeFirst

default void removeFirst(@NotNull
                         @NotNull Icon item)

clears the first slot where the given item is in.

the items will be compared using ItemStack.isSimilar(ItemStack) to check if the are equal.

Icon.getItem() is used to get the item that will be compared against the amount stored in the item is ignored for simplicity.

Parameters:

item - the item as a Icon that shall be removed from the inventory.

removeAmount

default void removeAmount(@NotNull
                          @NotNull org.bukkit.inventory.ItemStack item,
                          int amount)

removes the specified amount of items from the inventory.

the items will be compared using ItemStack.isSimilar(ItemStack) to check if the are equal.

Parameters:

item - the item as an ItemStack that shall be removed from the inventory.

amount - the amount that shall be removed.

removeAmount

default void removeAmount(@NotNull
                          @NotNull Icon item,
                          int amount)

removes the specified amount of items from the inventory.

the items will be compared using ItemStack.isSimilar(ItemStack) to check if the are equal.

Icon.getItem() is used to get the item that will be compared against

Parameters:

item - the item as a Icon that shall be removed from the inventory.

amount - the amount that shall be removed.

removeAll

default void removeAll(@NotNull
                       @NotNull org.bukkit.inventory.ItemStack item)

removes all occurrences of the item from the inventory.

the items will be compared using ItemStack.isSimilar(ItemStack) to check if the are equal.

Parameters:

item - the item as an ItemStack that shall be removed from the inventory.

removeAll

default void removeAll(@NotNull
                       @NotNull Icon item)

removes all occurrences of the item from the inventory.

the items will be compared using ItemStack.isSimilar(ItemStack) to check if the are equal.

Icon.getItem() is used to get the item that will be compared against.

Parameters:

item - the item as an Icon that shall be removed from the inventory.

fill

@NotNull
default @NotNull InventoryContents fill(@NotNull
                                                 @NotNull Icon item)

fills the inventory with the given item.

Parameters:

item - the item to fill.

Returns:

this, for chained calls.

fillEmpties

@NotNull
default @NotNull InventoryContents fillEmpties(@NotNull
                                                        @NotNull Icon item)

fills the empty slots of the inventory with the given item.

Parameters:

item - the item to fill.

Returns:

this, for chained calls.

fillRow

@NotNull
default @NotNull InventoryContents fillRow(int row,
                                                    @NotNull
                                                    @NotNull Icon item)

fills the given inventory row with the given item.

Parameters:

row - the row to fill.

item - the item to fill.

Returns:

this, for chained calls.

fillColumn

@NotNull
default @NotNull InventoryContents fillColumn(int column,
                                                       @NotNull
                                                       @NotNull Icon item)

fills the given inventory column with the given item.

Parameters:

column - the column to fill.

item - the item to fill.

Returns:

this, for chained calls.

fillBorders

@NotNull
default @NotNull InventoryContents fillBorders(@NotNull
                                                        @NotNull Icon item)

fills the inventory borders with the given item.

Parameters:

item - the item to fill.

Returns:

this, for chained calls.

fillRect

@NotNull
default @NotNull InventoryContents fillRect(int fromIndex,
                                                     int toIndex,
                                                     @NotNull
                                                     @NotNull Icon item)

fills a rectangle inside the inventory using the given positions.

the created rectangle will have its top-left position at the given from slot index and its bottom-right position at the given to slot index.

Parameters:

fromIndex - the slot index at the top-left position.

toIndex - the slot index at the bottom-right position.

item - the item to fill.

Returns:

this, for chained calls.

fillRect

@NotNull
default @NotNull InventoryContents fillRect(int fromRow,
                                                     int fromColumn,
                                                     int toRow,
                                                     int toColumn,
                                                     @NotNull
                                                     @NotNull Icon item)

same as fillRect(int, int, Icon), but with SlotPos instead of the indexes.

Parameters:

fromRow - the row of the first corner of the rect.

fromColumn - the column of the first corner of the rect.

toRow - the row of the second corner of the rect.

toColumn - the column of the second corner of the rect.

item - the item to fill the rect with.

Returns:

this, for chained calls.

See Also:

fillRect(int, int, Icon)

fillRect

@NotNull
default @NotNull InventoryContents fillRect(@NotNull
                                                     @NotNull SlotPos fromPos,
                                                     @NotNull
                                                     @NotNull SlotPos toPos,
                                                     @NotNull
                                                     @NotNull Icon item)

same as fillRect(int, int, Icon), but with rows and columns instead of the indexes.

Parameters:

fromPos - the first corner of the rect.

toPos - the second corner of the rect.

item - the item to fill the rect with.

Returns:

this, for chained calls.

See Also:

fillRect(int, int, Icon)

fillSquare

@NotNull
default @NotNull InventoryContents fillSquare(int fromIndex,
                                                       int toIndex,
                                                       @NotNull
                                                       @NotNull Icon item)

completely fills the provided square with the given Icon.

Parameters:

fromIndex - the slot index of the upper left corner.

toIndex - the slot index of the lower right corner.

item - the item.

Returns:

this, for chained calls.

fillSquare

@NotNull
default @NotNull InventoryContents fillSquare(int fromRow,
                                                       int fromColumn,
                                                       int toRow,
                                                       int toColumn,
                                                       @NotNull
                                                       @NotNull Icon item)

completely fills the provided square with the given Icon.

Parameters:

fromRow - the row of the upper left corner.

fromColumn - the column of the upper-left corner.

toRow - the row of the lower right corner.

toColumn - the column of the lower right corner.

item - the item.

Returns:

this, for chained calls.

fillSquare

@NotNull
default @NotNull InventoryContents fillSquare(@NotNull
                                                       @NotNull SlotPos fromPos,
                                                       @NotNull
                                                       @NotNull SlotPos toPos,
                                                       @NotNull
                                                       @NotNull Icon item)

completely fills the provided square with the given Icon.

Parameters:

fromPos - the slot position of the upper left corner.

toPos - the slot position of the lower right corner.

item - the item.

Returns:

this, for chained calls.

fillPattern

@NotNull
default @NotNull InventoryContents fillPattern(@NotNull
                                                        @NotNull Pattern<Icon> pattern)

fills the inventory with the given Pattern.

the pattern will start at the first slot.

Parameters:

pattern - the filling pattern.

Returns:

this, for chained calls.

See Also:

to fill the pattern from the provided slot index., to fill the pattern from the provided row and column., to fill the pattern from the provided slot pos.

fillPattern

@NotNull
default @NotNull InventoryContents fillPattern(@NotNull
                                                        @NotNull Pattern<Icon> pattern,
                                                        int startIndex)

fills the inventory with the given Pattern.

the pattern will start at the given slot index.

Parameters:

pattern - the filling pattern.

startIndex - the start slot index for the filling.

Returns:

this, for chained calls.

See Also:

to fill the pattern from the first slot., to fill the pattern from the provided row and column., to fill the pattern from the provided slot pos.

fillPattern

@NotNull
default @NotNull InventoryContents fillPattern(@NotNull
                                                        @NotNull Pattern<Icon> pattern,
                                                        int startRow,
                                                        int startColumn)

fills the inventory with the given Pattern.

the pattern will start at the given slot position based on the provided row and column.

Parameters:

pattern - the filling pattern.

startRow - the start row of the slot for filling.

startColumn - the start column of the slot for filling.

Returns:

this, for chained calls.

See Also:

to fill the pattern from the first slot., to fill the pattern from the provided slot index., to fill the pattern from the provided slot pos.

fillPattern

@NotNull
default @NotNull InventoryContents fillPattern(@NotNull
                                                        @NotNull Pattern<Icon> pattern,
                                                        @NotNull
                                                        @NotNull SlotPos startPos)

fills the inventory with the given Pattern.

the pattern will start at the given slot position.

Parameters:

pattern - the filling pattern.

startPos - the start position of the slot for filling.

Returns:

this, for chained calls.

See Also:

to fill the pattern from the first slot., to fill the pattern from the provided slot index., to fill the pattern from the provided row and column.

fillPatternRepeating

@NotNull
default @NotNull InventoryContents fillPatternRepeating(@NotNull
                                                                 @NotNull Pattern<Icon> pattern)

fills the inventory with the given Pattern.

the pattern will start at the first slot and end at the last slot. if the pattern is not big enough, it will wrap around to the other side and repeat the pattern.

the top-left corner of the specified inventory area is also the top-left corner of the specified pattern. for this to work the pattern needs to be created with wrapAround enabled.

Parameters:

pattern - the filling pattern.

Returns:

this, for chained calls.

See Also:

to fill a repeating pattern using slot indexes., to fill a repeating pattern using slot positions contructed from their rows and columns., to fill a repeating pattern using slot positions.

fillPatternRepeating

@NotNull
default @NotNull InventoryContents fillPatternRepeating(@NotNull
                                                                 @NotNull Pattern<Icon> pattern,
                                                                 int startIndex,
                                                                 int endIndex)

fills the inventory with the given Pattern.

the pattern will start at the first slot index and end at the second slot index. if the pattern is not big enough, it will wrap around to the other side and repeat the pattern.

the top-left corner of the specified inventory area is also the top-left corner of the specified pattern.

if endIndex is a negative value it is set to the bottom-right corner. for this to work the pattern needs to be created with wrapAround enabled.

Parameters:

pattern - the filling pattern.

startIndex - the start slot index where the pattern should begin.

endIndex - the end slot index where the pattern should end.

Returns:

this, for chained calls.

See Also:

to fill a repeating pattern into the whole inventory., to fill a repeating pattern using slot positions contructed from their rows and columns., to fill a repeating pattern using slot positions.

fillPatternRepeating

@NotNull
default @NotNull InventoryContents fillPatternRepeating(@NotNull
                                                                 @NotNull Pattern<Icon> pattern,
                                                                 int startRow,
                                                                 int startColumn,
                                                                 int endRow,
                                                                 int endColumn)

fills the inventory with the given Pattern.

the pattern will start at the given slot position and end at the second slot position. if the pattern is not big enough, it will wrap around to the other side and repeat the pattern.

the top-left corner of the specified inventory area is also the top-left corner of the specified pattern.

if endRow is a negative value, endRow is automatically set to the max row size, if endColumn is a negative value, endColumn is automatically set to the max column size. for this to work the pattern needs to be created with wrapAround enabled.

Parameters:

pattern - the filling pattern.

startRow - the start row of the slot for filling.

startColumn - the start column of the slot for filling.

endRow - the end row of the slot for filling.

endColumn - the end column of the slot for filling.

Returns:

this, for chained calls.

See Also:

to fill a repeating pattern into the whole inventory., to fill a repeating pattern using slot indexes., to fill a repeating pattern using slot positions.

fillPatternRepeating

@NotNull
default @NotNull InventoryContents fillPatternRepeating(@NotNull
                                                                 @NotNull Pattern<Icon> pattern,
                                                                 @NotNull
                                                                 @NotNull SlotPos startPos,
                                                                 @NotNull
                                                                 @NotNull SlotPos endPos)

fills the inventory with the given Pattern.

the pattern will start at the given slot position and end at the second slot position. if the pattern is not big enough, it will wrap around to the other side and repeat the pattern.

the top-left corner of the specified inventory area is also the top-left corner of the specified pattern.

if the row of endPos is a negative value, endRow is automatically set to the max row size, if the column of endPos is a negative value, endColumn is automatically set to the max column size. for this to work the pattern needs to be created with wrapAround enabled.

Parameters:

pattern - the filling pattern.

startPos - the position where the pattern should start.

endPos - the position where the pattern should end.

Returns:

this, for chained calls.

See Also:

to fill a repeating pattern into the whole inventory., to fill a repeating pattern using slot indexes., to fill a repeating pattern using slot positions contructed from their rows and columns.

getBottomInventory

@NotNull
default @NotNull org.bukkit.inventory.Inventory getBottomInventory()

gets player's bottom of the inventory.

Returns:

bottom inventory instance.

getTopInventory

@NotNull
default @NotNull org.bukkit.inventory.Inventory getTopInventory()

gets player's top of the inventory.

Returns:

top inventory instance.

reopen

default void reopen()

re open the current page.

openNext

default void openNext()

opens the next page with using Pagination.

openPrevious

default void openPrevious()

opens the previous page with using Pagination.

notifyUpdate

default void notifyUpdate()

runs Page.notifyUpdate(InventoryContents) method of this.

notifyUpdateForAll

default void notifyUpdateForAll()

runs Page.notifyUpdateForAll() method of this.

notifyUpdateForAllById

default void notifyUpdateForAllById()

runs Page.notifyUpdateForAllById() method of this.

setEditable

default InventoryContents setEditable(@NotNull
                                      @NotNull SlotPos slot)

makes a slot editable, which enables the player to put items in and take items out of the inventory in the specified slot.

Parameters:

slot - the slot to set editable.

Returns:

this, for chained calls.

page

@NotNull
@NotNull Page page()

obtains the page of the this.

Returns:

a page instance.

pagination

@NotNull
@NotNull Pagination pagination()

gets the pagination system linked to this.

Returns:

the pagination

all

@NotNull
@NotNull Icon[][] all()

returns a 2D array of Icon containing all the items of the inventory.

the Icons can be null when there is no item in the corresponding slot.

Returns:

the items of the inventory.

player

@NotNull
@NotNull org.bukkit.entity.Player player()

obtains the player of the contents.

Returns:

the player instance.

iterator

@NotNull
@NotNull Optional<SlotIterator> iterator(@NotNull
                                                  @NotNull String id)

gets a previously registered iterator named with the given id.

if no iterator is found, this will return Optional.empty().

Parameters:

id - the id of the iterator.

Returns:

the found iterator, if there is one.

getProperty

@Nullable
<T> T getProperty(@NotNull
                            @NotNull String name)

gets the value of the property with the given name.

Type Parameters:

T - the type of the value.

Parameters:

name - the property's name.

Returns:

the property's value.

getPropertyOrDefault

@NotNull
<T> T getPropertyOrDefault(@NotNull
                                    @NotNull String name,
                                    @NotNull
                                    T def)

gets the value of the property with the given name, or a default value if the property isn't set.

Type Parameters:

T - the type of the value.

Parameters:

name - the property's name.

def - the default value.

Returns:

the property's value, or the given default value.

newIterator

@NotNull
@NotNull SlotIterator newIterator(@NotNull
                                           @NotNull String id,
                                           @NotNull
                                           SlotIterator.Type type,
                                           int startRow,
                                           int startColumn)

creates and registers an iterator using a given id.

you can retrieve the iterator at any time using the iterator(String) method.

Parameters:

id - the id of the iterator.

type - the type of the iterator.

startRow - the starting row of the iterator.

startColumn - the starting column of the iterator.

Returns:

the newly created iterator.

set

@NotNull
@NotNull InventoryContents set(int row,
                                        int column,
                                        @Nullable
                                        @Nullable Icon item)

same as set(int, Icon), but with a row and a column instead of the index.

Parameters:

row - the row to set.

column - the column to set.

item - the item to set.

Returns:

this, for chained calls.

setProperty

@NotNull
@NotNull InventoryContents setProperty(@NotNull
                                                @NotNull String name,
                                                @NotNull
                                                @NotNull Object value)

sets the value of the property with the given name.

this will replace the existing value for the property, if there is one.

Parameters:

name - the property's name.

value - the new property's value.

Returns:

this, for chained calls.

setEditable

InventoryContents setEditable(@NotNull
                              @NotNull SlotPos slot,
                              boolean editable)

makes a slot editable, which enables the player to put items in and take items out of the inventory in the specified slot.

Parameters:

slot - the slot to set editable.

editable - true to make a slot editable, false to make it 'static' again.

Returns:

this, for chained calls.

isEditable

boolean isEditable(@NotNull
                   @NotNull SlotPos slot)

returns if a given slot is editable or not.

Parameters:

slot - The slot to check.

Returns:

true if the editable.