Package de.studiocode.invui.gui.builder

Class GUIBuilder<G extends GUI>

java.lang.Object

de.studiocode.invui.gui.builder.GUIBuilder<G>

public class GUIBuilder<G extends GUI>
extends Object

A builder class to easily construct GUIs.
It provides similar functionality to Bukkit's ShapedRecipe, as it allows for a structure String which defines the layout of the GUI.

Constructor Summary

Constructors

Constructor	Description
GUIBuilder(@NotNull GUIType<G> guiType)

Method Summary

Modifier and Type	Method	Description
GUIBuilder<G>	addGUI(@NotNull GUI gui)
GUIBuilder<G>	addIngredient(char key, @NotNull SlotElement element)
GUIBuilder<G>	addIngredient(char key, @NotNull Marker marker)
GUIBuilder<G>	addIngredient(char key, @NotNull Item item)
GUIBuilder<G>	addIngredient(char key, @NotNull ItemProvider itemProvider)
GUIBuilder<G>	addIngredient(char key, @NotNull VirtualInventory inventory)
GUIBuilder<G>	addIngredient(char key, @NotNull VirtualInventory inventory, @Nullable ItemProvider background)
GUIBuilder<G>	addIngredient(char key, @NotNull Supplier<? extends Item> itemSupplier)
GUIBuilder<G>	addIngredient(char key, @NotNull org.bukkit.inventory.ItemStack itemStack)
GUIBuilder<G>	addIngredientElementSupplier(char key, @NotNull Supplier<? extends SlotElement> elementSupplier)
GUIBuilder<G>	addItem(@NotNull Item item)
G	build()
GUIBuilder<G>	setBackground(@Nullable ItemProvider background)
GUIBuilder<G>	setGUIs(@NotNull List<GUI> guis)
GUIBuilder<G>	setInventory(@NotNull VirtualInventory inventory)
GUIBuilder<G>	setItems(@NotNull List<Item> items)
GUIBuilder<G>	setStructure(int width, int height, @NotNull String structureData)
GUIBuilder<G>	setStructure(@NotNull Structure structure)
GUIBuilder<G>	setStructure(@NotNull String... structureData)

Methods inherited from class java.lang.Object

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

Constructor Details

GUIBuilder

public GUIBuilder(@NotNull
 @NotNull GUIType<G> guiType)

Method Details

setStructure

public GUIBuilder<G> setStructure(int width,
 int height,
 @NotNull
 @NotNull String structureData)

setStructure

public GUIBuilder<G> setStructure(@NotNull
 @NotNull String... structureData)

setStructure

public GUIBuilder<G> setStructure(@NotNull
 @NotNull Structure structure)

addIngredient

public GUIBuilder<G> addIngredient(char key,
 @NotNull
 @NotNull org.bukkit.inventory.ItemStack itemStack)

addIngredient

public GUIBuilder<G> addIngredient(char key,
 @NotNull
 @NotNull ItemProvider itemProvider)

addIngredient

public GUIBuilder<G> addIngredient(char key,
 @NotNull
 @NotNull Item item)

addIngredient

public GUIBuilder<G> addIngredient(char key,
 @NotNull
 @NotNull VirtualInventory inventory)

addIngredient

public GUIBuilder<G> addIngredient(char key,
 @NotNull
 @NotNull VirtualInventory inventory,
 @Nullable
 @Nullable ItemProvider background)

addIngredient

public GUIBuilder<G> addIngredient(char key,
 @NotNull
 @NotNull SlotElement element)

addIngredient

public GUIBuilder<G> addIngredient(char key,
 @NotNull
 @NotNull Marker marker)

addIngredient

public GUIBuilder<G> addIngredient(char key,
 @NotNull
 @NotNull Supplier<? extends Item> itemSupplier)

addIngredientElementSupplier

public GUIBuilder<G> addIngredientElementSupplier(char key,
 @NotNull
 @NotNull Supplier<? extends SlotElement> elementSupplier)

setItems

public GUIBuilder<G> setItems(@NotNull
 @NotNull List<Item> items)

addItem

public GUIBuilder<G> addItem(@NotNull
 @NotNull Item item)

setGUIs

public GUIBuilder<G> setGUIs(@NotNull
 @NotNull List<GUI> guis)

addGUI

public GUIBuilder<G> addGUI(@NotNull
 @NotNull GUI gui)

setInventory

public GUIBuilder<G> setInventory(@NotNull
 @NotNull VirtualInventory inventory)

setBackground

public GUIBuilder<G> setBackground(@Nullable
 @Nullable ItemProvider background)

build

public G build()