io.github.portlek.smartinventory

Interface SlotIterator

All Known Implementing Classes:

BasicSlotIterator

public interface SlotIterator

a class that allows you to iterate through the slots of an inventory either horizontally or vertically.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	SlotIterator.Type the iterate type of the inventory.

Method Summary

Modifier and Type	Method and Description
@NotNull SlotIterator	allowOverride(boolean override) sets the value of the allow override option.
@NotNull SlotIterator	blacklist(int index) blacklists the given slot index.
@NotNull SlotIterator	blacklist(int row, int column) blacklists the given slot position.
default @NotNull SlotIterator	blacklist(@NotNull SlotPos slotPos) blacklists the given slot position.
default @NotNull SlotIterator	blacklistPattern(@NotNull Pattern<Boolean> pattern) this method has the inverse effect of withPattern(Pattern), where the other method would only allow the iterator to go, this method prohibits this slots to iterate over.
@NotNull SlotIterator	blacklistPattern(@NotNull Pattern<Boolean> pattern, int rowOffset, int columnOffset) This method has the inverse effect of withPattern(Pattern, int, int), where the other method would only allow the iterator to go, this method prohibits this slots to iterate over.
int	column() gets the current column of the iterator.
@NotNull SlotIterator	column(int column) sets the current column of the iterator.
boolean	doesAllowOverride() gets the value of the allow override option.
boolean	ended() checks if this iterator has been ended.
@NotNull SlotIterator	endPosition(int row, int column) sets the slot where the iterator should end.
default @NotNull SlotIterator	endPosition(@NotNull SlotPos endPosition) sets the slot where the iterator should end.
@NotNull Optional<Icon>	get() gets the icon at the current position in the inventory.
@NotNull SlotIterator	next() moves the cursor to the next position inside the inventory.
@NotNull SlotIterator	previous() moves the cursor to the previous position inside the inventory.
@NotNull SlotIterator	reset() resets iterator to its original position specified while creation.
int	row() gets the current row of the iterator.
@NotNull SlotIterator	row(int row) sets the current row of the iterator.
@NotNull SlotIterator	set(@NotNull Icon icon) replaces the icon at the current position in the inventory by the given icon.
boolean	started() checks if this iterator has been started.
default @NotNull SlotIterator	withPattern(@NotNull Pattern<Boolean> pattern) setting a pattern using this method will use it as a guideline where the slot iterator can set icons or not.
@NotNull SlotIterator	withPattern(@NotNull Pattern<Boolean> pattern, int rowOffset, int columnOffset) setting a pattern using this method will use it as a guideline where the slot iterator can set icons or not.

Method Detail

blacklist

@NotNull
default @NotNull SlotIterator blacklist(@NotNull
                                                 @NotNull SlotPos slotPos)

blacklists the given slot position.

Blacklisting a slot will make the iterator skip the given slot and directly go to the next un-blacklisted slot.

Parameters:

slotPos - the slot to blacklist.

Returns:

this, for chained calls.

endPosition

@NotNull
default @NotNull SlotIterator endPosition(@NotNull
                                                   @NotNull SlotPos endPosition)

sets the slot where the iterator should end.

if the row of the SlotPos is a negative value, it is set to the maximum row count.

if the column of the SlotPos is a negative value, it is set to maximum column count.

Parameters:

endPosition - the slot where the iterator should end.

Returns:

this, for chained calls.

withPattern

@NotNull
default @NotNull SlotIterator withPattern(@NotNull
                                                   @NotNull Pattern<Boolean> pattern)

setting a pattern using this method will use it as a guideline where the slot iterator can set icons or not. if the pattern doesn't fill the whole inventory, the slot iterator is limited to the space the pattern provides. if the pattern has the wrapAround flag set, then the iterator can iterate over the entire inventory, even if the pattern would not fill it by itself.

if the provided pattern has no default value set, this method will set it to false.

if you pass null into the pattern parameter, this functionality will be disabled and the iterator will continue to work as normal.

Parameters:

pattern - the pattern to use as a guideline.

Returns:

this, for chained calls.

blacklistPattern

@NotNull
default @NotNull SlotIterator blacklistPattern(@NotNull
                                                        @NotNull Pattern<Boolean> pattern)

this method has the inverse effect of withPattern(Pattern), where the other method would only allow the iterator to go, this method prohibits this slots to iterate over.

Parameters:

pattern - the pattern where the slot iterator cannot iterate.

Returns:

this, for chained calls.

get

@NotNull
@NotNull Optional<Icon> get()

gets the icon at the current position in the inventory.

Returns:

the icon at the current position.

set

@NotNull
@NotNull SlotIterator set(@NotNull
                                   @NotNull Icon icon)

replaces the icon at the current position in the inventory by the given icon.

Parameters:

icon - the new icon.

Returns:

this, for chained calls.

previous

@NotNull
@NotNull SlotIterator previous()

moves the cursor to the previous position inside the inventory.

this has no effect if the cursor is already at the first position of the inventory.

Returns:

this, for chained calls.

next

@NotNull
@NotNull SlotIterator next()

moves the cursor to the next position inside the inventory.

this has no effect if the cursor is already at the last position of the inventory.

Returns:

this, for chained calls.

blacklist

@NotNull
@NotNull SlotIterator blacklist(int index)

blacklists the given slot index.

blacklisting a slot will make the iterator skip the given slot and directly go to the next un-blacklisted slot.

Parameters:

index - the index to blacklist.

Returns:

this, for chained calls.

blacklist

@NotNull
@NotNull SlotIterator blacklist(int row,
                                         int column)

blacklists the given slot position.

blacklisting a slot will make the iterator skip the given slot and directly go to the next un-blacklisted slot.

Parameters:

row - the row of the slot to blacklist.

column - the column of the slot to blacklist.

Returns:

this, for chained calls.

row

int row()

gets the current row of the iterator.

Returns:

the current row.

row

@NotNull
@NotNull SlotIterator row(int row)

sets the current row of the iterator.

Parameters:

row - the new row.

Returns:

this, for chained calls.

column

int column()

gets the current column of the iterator.

Returns:

the current column.

column

@NotNull
@NotNull SlotIterator column(int column)

sets the current column of the iterator.

Parameters:

column - the new column.

Returns:

this, for chained calls.

reset

@NotNull
@NotNull SlotIterator reset()

resets iterator to its original position specified while creation.

when the iterator gets reset to its original position, started gets set back to false.

Returns:

this, for chained calls.

started

boolean started()

checks if this iterator has been started.

an iterator is not started until any of previous() or next() methods have been called.

Returns:

true if this iterator has been started.

ended

boolean ended()

checks if this iterator has been ended.

an iterator is not ended until it has reached the last slot of the inventory.

Returns:

true if this iterator has been ended.

endPosition

@NotNull
@NotNull SlotIterator endPosition(int row,
                                           int column)

sets the slot where the iterator should end.

if the row is a negative value, it is set to the maximum row count.

if the column is a negative value, it is set to maximum column count.

Parameters:

row - the row where the iterator should end.

column - the column where the iterator should end.

Returns:

this, for chained calls.

doesAllowOverride

boolean doesAllowOverride()

gets the value of the allow override option.

- if this is true, the iterator will override any existing icon it founds on its way.

- if this is false, the iterator will skip the slots which are not empty.

Returns:

true if this iterator allows to override.

allowOverride

@NotNull
@NotNull SlotIterator allowOverride(boolean override)

sets the value of the allow override option.

- if this is true, the iterator will override any existing icon it founds on its way.

- if this is false, the iterator will skip the slots which are not empty.

Parameters:

override - the value of the allow override option.

Returns:

this, for chained calls.

withPattern

@NotNull
@NotNull SlotIterator withPattern(@NotNull
                                           @NotNull Pattern<Boolean> pattern,
                                           int rowOffset,
                                           int columnOffset)

setting a pattern using this method will use it as a guideline where the slot iterator can set icons or not. if the pattern doesn't fill the whole inventory, the slot iterator is limited to the space the pattern provides. if the pattern has the wrapAround flag set, then the iterator can iterate over the entire inventory, even if the pattern would not fill it by itself.

the offset defines the top-left corner of the pattern. if the wrapAround flag is set, then the entire pattern will be just shifted by the given amount.

if the provided pattern has no default value set, this method will set it to false.

if you pass null into the pattern parameter, this functionality will be disabled and the iterator will continue to work as normal.

Parameters:

pattern - the pattern to use as a guideline.

rowOffset - the row offset from the top left corner.

columnOffset - the column offset from the top left corner.

Returns:

this, for chained calls.

blacklistPattern

@NotNull
@NotNull SlotIterator blacklistPattern(@NotNull
                                                @NotNull Pattern<Boolean> pattern,
                                                int rowOffset,
                                                int columnOffset)

This method has the inverse effect of withPattern(Pattern, int, int), where the other method would only allow the iterator to go, this method prohibits this slots to iterate over.

Parameters:

pattern - the pattern where the slot iterator cannot iterate.

rowOffset - the row offset from the top left corner.

columnOffset - the column offset from the top left corner.

Returns:

this, for chained calls.