Package dev.triumphteam.gui.guis

Class Gui

java.lang.Object

dev.triumphteam.gui.guis.BaseGui

dev.triumphteam.gui.guis.Gui

All Implemented Interfaces:

org.bukkit.inventory.InventoryHolder

public class Gui
extends BaseGui

Standard GUI implementation of BaseGui

Constructor Summary

Constructors

Constructor	Description
Gui(int rows, @NotNull String title)	Deprecated. In favor of Gui(int, String, Set)
Gui(int rows, @NotNull String title, @NotNull Set<InteractionModifier> interactionModifiers)	Main constructor for the GUI
Gui(@NotNull GuiType guiType, @NotNull String title)	Deprecated. In favor of Gui(GuiType, String, Set)
Gui(@NotNull GuiType guiType, @NotNull String title, @NotNull Set<InteractionModifier> interactionModifiers)	Alternative constructor that takes both a GuiType and a set of InteractionModifier
Gui(@NotNull String title)	Deprecated. In favor of Gui(int, String, Set)

Method Summary

Modifier and Type	Method	Description
static @NotNull SimpleBuilder	gui()	Creates a SimpleBuilder with CHEST as the GuiType
static @NotNull SimpleBuilder	gui(@NotNull GuiType type)	Creates a SimpleBuilder to build a Gui
static @NotNull PaginatedBuilder	paginated()	Creates a PaginatedBuilder to build a PaginatedGui
static @NotNull ScrollingBuilder	scrolling()	Creates a ScrollingBuilder with VERTICAL as the ScrollType
static @NotNull ScrollingBuilder	scrolling(@NotNull ScrollType scrollType)	Creates a ScrollingBuilder to build a ScrollingGui
static @NotNull StorageBuilder	storage()	Creates a StorageBuilder.

Methods inherited from class dev.triumphteam.gui.guis.BaseGui

addItem, addItem, addSlotAction, addSlotAction, allInteractionsDisabled, allowsOtherActions, canDropItems, canPlaceItems, canSwapItems, canTakeItems, close, close, disableAllInteractions, disableItemDrop, disableItemPlace, disableItemSwap, disableItemTake, disableOtherActions, enableAllInteractions, enableItemDrop, enableItemPlace, enableItemSwap, enableItemTake, enableOtherActions, getFiller, getGuiItem, getGuiItems, getInventory, getRows, getTitle, guiType, isUpdating, open, removeItem, removeItem, removeItem, removeItem, setCloseGuiAction, setDefaultClickAction, setDefaultTopClickAction, setDragAction, setInventory, setItem, setItem, setItem, setOpenGuiAction, setOutsideClickAction, setPlayerInventoryAction, setUpdating, title, update, updateItem, updateItem, updateItem, updateItem, updateTitle

Methods inherited from class java.lang.Object

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

Constructor Details

Gui

public Gui(int rows,
 @NotNull
 @NotNull String title,
 @NotNull
 @NotNull Set<InteractionModifier> interactionModifiers)

Main constructor for the GUI

Parameters:

rows - The amount of rows the GUI should have

title - The GUI's title using String

interactionModifiers - A set containing the InteractionModifier this GUI should use

Since:

3.0.3

Gui

public Gui(@NotNull
 @NotNull GuiType guiType,
 @NotNull
 @NotNull String title,
 @NotNull
 @NotNull Set<InteractionModifier> interactionModifiers)

Alternative constructor that takes both a GuiType and a set of InteractionModifier

Parameters:

guiType - The GuiType to be used

title - The GUI's title using String

interactionModifiers - A set containing the InteractionModifier this GUI should use

Since:

3.0.3

Gui

@Deprecated
public Gui(int rows,
 @NotNull
 @NotNull String title)

Deprecated.

In favor of Gui(int, String, Set)

Old main constructor for the GUI

Parameters:

rows - The amount of rows the GUI should have

title - The GUI's title

Gui

@Deprecated
public Gui(@NotNull
 @NotNull String title)

Deprecated.

In favor of Gui(int, String, Set)

Alternative constructor that defaults to 1 row

Parameters:

title - The GUI's title

Gui

@Deprecated
public Gui(@NotNull
 @NotNull GuiType guiType,
 @NotNull
 @NotNull String title)

Deprecated.

In favor of Gui(GuiType, String, Set)

Main constructor that takes a GuiType instead of rows

Parameters:

guiType - The GuiType to be used

title - The GUI's title

Method Details

gui

@NotNull
@Contract("_ -> new")
public static @NotNull SimpleBuilder gui(@NotNull
 @NotNull GuiType type)

Creates a SimpleBuilder to build a Gui

Parameters:

type - The GuiType to be used

Returns:

A SimpleBuilder

Since:

3.0.0

gui

@NotNull
@Contract(" -> new")
public static @NotNull SimpleBuilder gui()

Creates a SimpleBuilder with CHEST as the GuiType

Returns:

A CHEST SimpleBuilder

Since:

3.0.0

storage

@NotNull
@Contract(" -> new")
public static @NotNull StorageBuilder storage()

Creates a StorageBuilder.

Returns:

A CHEST StorageBuilder.

Since:

3.0.0.

paginated

@NotNull
@Contract(" -> new")
public static @NotNull PaginatedBuilder paginated()

Creates a PaginatedBuilder to build a PaginatedGui

Returns:

A PaginatedBuilder

Since:

3.0.0

scrolling

@NotNull
@Contract("_ -> new")
public static @NotNull ScrollingBuilder scrolling(@NotNull
 @NotNull ScrollType scrollType)

Creates a ScrollingBuilder to build a ScrollingGui

Parameters:

scrollType - The ScrollType to be used by the GUI

Returns:

A ScrollingBuilder

Since:

3.0.0

scrolling

@NotNull
@Contract(" -> new")
public static @NotNull ScrollingBuilder scrolling()

Creates a ScrollingBuilder with VERTICAL as the ScrollType

Returns:

A vertical SimpleBuilder

Since:

3.0.0