Package com.kamikazejam.kamicommon.menu

Class AbstractMenu<M extends AbstractMenu<M>>

java.lang.Object

com.kamikazejam.kamicommon.menu.api.MenuHolder

com.kamikazejam.kamicommon.menu.AbstractMenu<M>

All Implemented Interfaces:

UpdatingMenu, Menu<M>, InventoryHolder

Direct Known Subclasses:

OneClickMenu, PaginatedMenu, SimpleMenu

public abstract sealed class AbstractMenu<M extends AbstractMenu<M>>
extends MenuHolder
implements Menu<M>, UpdatingMenu
permits SimpleMenu, PaginatedMenu, OneClickMenu

Field Summary

Fields

Modifier and Type	Field	Description
protected final MenuEvents<M>	events
protected final @NotNull PrioritizedMenuIconMap<M>	menuIcons
protected final MenuOptions<M>	options
protected final Player	player

Fields inherited from class com.kamikazejam.kamicommon.menu.api.MenuHolder

inventory, size, title

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractMenu(@NotNull AbstractMenuBuilder<M,?> builder, @NotNull Player player)

Method Summary

Modifier and Type	Method	Description
boolean	close()	Close the Inventory for the Player that this menu was created for. Identical to calling HumanEntity.closeInventory().
@Nullable MenuIcon<M>	getFillerIcon()
@NotNull Map<String,MenuIcon<M>>	getMenuIcons()
@NotNull IMenuIconsAccess<M>	getMenuIconsAccess()
M	modifyIcons(@NotNull Consumer<IMenuIconsAccess<M>> consumer)
@Nullable InventoryView	open()	Open the Inventory for the Player that this menu was created for.
@Nullable InventoryView	open(boolean resetTickCounter)	Open the Inventory for the Player that this menu was created for.
protected void	placeFiller(Map<Integer,@Nullable ItemStack> newMenuState, Set<Integer> slots, int tick)
void	placeIcons(@Nullable Predicate<MenuIcon<M>> needsUpdate)	Manually trigger an update for all icons matching this predicate. If the predicate is passed, the icon will be re-built and set in the inventory. If the predicate is null, it will always update all icons.
void	reopenMenu()	Attempt to reopen the menu for the given player.
void	reopenMenu(boolean resetTickCounter)	Attempt to reopen the menu for the given player.
void	resizeMenu(@NotNull MenuSize size)
void	setSize(@NotNull MenuSize size)
void	updateOneTick()

Methods inherited from class com.kamikazejam.kamicommon.menu.api.MenuHolder

clear, closeAll, deleteInventory, equals, firstEmpty, firstEmpty, firstEmpty, getHolder, getInventory, getItem, getMenuSize, getRawInventory, getSize, getViewers, hashCode, replaceTitle, setItem, setItem

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.kamikazejam.kamicommon.menu.Menu

buildClickData, buildPlayerClickData, getEvents, getMenuSize, getOptions

Methods inherited from interface com.kamikazejam.kamicommon.menu.api.icons.interfaces.UpdatingMenu

getInventory

Field Details

player

protected final Player player

menuIcons

@NotNull
protected final @NotNull PrioritizedMenuIconMap<M extends AbstractMenu<M>> menuIcons

events

protected final MenuEvents<M extends AbstractMenu<M>> events

options

protected final MenuOptions<M extends AbstractMenu<M>> options

Constructor Details

AbstractMenu

protected AbstractMenu(@NotNull
 @NotNull AbstractMenuBuilder<M,?> builder,
 @NotNull
 @NotNull Player player)

Method Details

reopenMenu

public void reopenMenu()

Description copied from interface: Menu

Attempt to reopen the menu for the given player. Depending on the menu type, this may not be possible for all possible
By default, this method will NOT reset the tick counter.
See Menu.reopenMenu(boolean) for reopening with reset.

Specified by:

reopenMenu in interface Menu<M extends AbstractMenu<M>>

reopenMenu

public void reopenMenu(boolean resetTickCounter)

Description copied from interface: Menu

Attempt to reopen the menu for the given player. Depending on the menu type, this may not be possible for all possible

Specified by:

reopenMenu in interface Menu<M extends AbstractMenu<M>>

Parameters:

resetTickCounter - If true, the tick counter will be reset to 0. This is useful for menus that are not paginated, and

open

@Nullable
public @Nullable InventoryView open()

Open the Inventory for the Player that this menu was created for.

Returns:

The InventoryView for the new menu, or null if the player was not online to open the menu for.

open

@Nullable
public @Nullable InventoryView open(boolean resetTickCounter)

Open the Inventory for the Player that this menu was created for.

Parameters:

resetTickCounter - If true, the tick counter will be reset to 0 when opening the menu.

Returns:

The InventoryView for the new menu, or null if the player was not online to open the menu for.

close

public boolean close()

Close the Inventory for the Player that this menu was created for.
Identical to calling HumanEntity.closeInventory().

Returns:

If the inventory was successfully closed. False if the player is no longer valid (not online).

setSize

public void setSize(@NotNull
 @NotNull MenuSize size)

resizeMenu

public void resizeMenu(@NotNull
 @NotNull MenuSize size)

modifyIcons

@NotNull
public M modifyIcons(@NotNull
 @NotNull Consumer<IMenuIconsAccess<M>> consumer)

getMenuIcons

@NotNull
public @NotNull Map<String,MenuIcon<M>> getMenuIcons()

Specified by:

getMenuIcons in interface Menu<M extends AbstractMenu<M>>

getMenuIconsAccess

@NotNull
public @NotNull IMenuIconsAccess<M> getMenuIconsAccess()

Specified by:

getMenuIconsAccess in interface Menu<M extends AbstractMenu<M>>

getFillerIcon

@Nullable
public @Nullable MenuIcon<M> getFillerIcon()

Specified by:

getFillerIcon in interface Menu<M extends AbstractMenu<M>>

updateOneTick

@Internal
public void updateOneTick()

Specified by:

updateOneTick in interface UpdatingMenu

placeIcons

public void placeIcons(@Nullable
 @Nullable Predicate<MenuIcon<M>> needsUpdate)

Manually trigger an update for all icons matching this predicate.
If the predicate is passed, the icon will be re-built and set in the inventory.
If the predicate is null, it will always update all icons.

Parameters:

needsUpdate - An optional predicate to filter which icons need new builders.

placeFiller

protected void placeFiller(Map<Integer,@Nullable ItemStack> newMenuState,
 Set<Integer> slots,
 int tick)