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(@NotNull GuiContainer guiContainer, @NotNull Set<InteractionModifier> interactionModifiers)

Method Summary

Modifier and Type	Method	Description
static @NotNull ChestGuiBuilder	gui()	Creates a ChestGuiBuilder with CHEST as the GuiType
static @NotNull TypedGuiBuilder	gui(@NotNull GuiType type)	Creates a TypedGuiBuilder 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, clearItems, close, close, disableAllInteractions, disableItemDrop, disableItemPlace, disableItemSwap, disableItemTake, disableOtherActions, enableAllInteractions, enableItemDrop, enableItemPlace, enableItemSwap, enableItemTake, enableOtherActions, getFiller, getGuiItem, getGuiItems, getInventory, getRows, guiContainer, 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(@NotNull
 @NotNull GuiContainer guiContainer,
 @NotNull
 @NotNull Set<InteractionModifier> interactionModifiers)

Method Details

gui

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

Creates a TypedGuiBuilder to build a Gui

Parameters:

type - The GuiType to be used

Returns:

A TypedGuiBuilder

Since:

3.0.0

gui

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

Creates a ChestGuiBuilder with CHEST as the GuiType

Returns:

A CHEST ChestGuiBuilder

Since:

3.0.0

storage

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

Creates a StorageBuilder.

Returns:

A CHEST StorageBuilder.

Since:

3.0.0.

paginated

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

Creates a PaginatedBuilder to build a PaginatedGui

Returns:

A PaginatedBuilder

Since:

3.0.0

scrolling

@Contract("_ -> new")
@NotNull
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

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

Creates a ScrollingBuilder with VERTICAL as the ScrollType

Returns:

A vertical ChestGuiBuilder

Since:

3.0.0