Package me.eddie.inventoryguiapi.gui.contents

Interface GUIContentsProvider

All Known Implementing Classes:

PaginatingGUIContentsProvider, PlatformDifferentiatedGUIContentsProvider, TradeInventoryExample

public interface GUIContentsProvider

Determines what contents to show viewers on each page, the title of each page and if there is another page after this one. Once the inventory for a given page has been opened the title won't be able to be changed without closing and re-opening the inventory, this is due to a limitation in the Bukkit API and/or Minecraft.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	GUIContentsProvider.GUIContentsResponse	The calculated result of a call to genContents(Player, int, GUISession, Callback) An instance of this object should be passed to Callback.call(Object) on the callback provided with genContents.

Field Summary

Fields

Modifier and Type	Field	Description
static final int	MAX_JAVA_TITLE_LENGTH	The maximum allowed title length of Minecraft Java Edition

Method Summary

Modifier and Type	Method	Description
void	genContents(org.bukkit.entity.Player viewer, int page, GUISession session, Callback<GUIContentsProvider.GUIContentsResponse> callback)	Calculate the GUIElements to display on this page and if another exists.
void	genTitle(org.bukkit.entity.Player viewer, int page, GUISession session, Callback<String> callback)	Calculate the title to display for a given page.

Field Details

MAX_JAVA_TITLE_LENGTH

static final int MAX_JAVA_TITLE_LENGTH

The maximum allowed title length of Minecraft Java Edition

See Also:

• Constant Field Values

Method Details

genContents

void genContents(org.bukkit.entity.Player viewer,
 int page,
 GUISession session,
 Callback<GUIContentsProvider.GUIContentsResponse> callback)

Calculate the GUIElements to display on this page and if another exists. Once calculated the result (a GUIContentsResponse) should be passed to the provided callback. If the callback isn't called then the GUI will not work properly.

Parameters:

viewer - The viewer of this inventory. In the case of a GUI with multiple viewers (SharedInventoryGUI) this will be whatever viewer caused this method to be called

page - The page to retrieve the contents for. Page 1 is the first page.

session - The GUISession being viewed

callback - The callback to pass the response to. If the callback isn't called then the GUI will not work properly. Use the Callback.call(Object) method of the callback.

genTitle

void genTitle(org.bukkit.entity.Player viewer,
 int page,
 GUISession session,
 Callback<String> callback)

Calculate the title to display for a given page. Once calculated the result (a String) should be passed to the provided callback. If the callback isn't called then the GUI will not work properly.

Parameters:

viewer - The viewer of this inventory. In the case of a GUI with multiple viewers (SharedInventoryGUI) this will be whatever viewer caused this method to be called

page - The page to retrieve the contents for. Page 1 is the first page.

session - The GUISession being viewed

callback - The callback to pass the response to. If the callback isn't called then the GUI will not work properly. Use the Callback.call(Object) method of the callback.