Package xyz.xenondevs.invui.gui

Class AbstractGui.AbstractBuilder<G extends Gui,S extends Gui.Builder<G,S>>

java.lang.Object

xyz.xenondevs.invui.gui.AbstractGui.AbstractBuilder<G,S>

Type Parameters:

G - The type of AbstractGui this builder builds

S - The type of the builder itself

All Implemented Interfaces:

Cloneable, Gui.Builder<G,S>

Direct Known Subclasses:

AbstractPagedGui.AbstractBuilder, AbstractScrollGui.AbstractBuilder, AbstractTabGui.AbstractBuilder

Enclosing class:

AbstractGui

public abstract static class AbstractGui.AbstractBuilder<G extends Gui,S extends Gui.Builder<G,S>>
extends Object
implements Gui.Builder<G,S>

A builder for AbstractGuis.

This class should only be used directly if you're creating a custom AbstractGui.AbstractBuilder for a custom AbstractGui implementation. Otherwise, use the static builder functions in the Gui interfaces, such as Gui.normal() to obtain a builder.

Nested Class Summary

Nested classes/interfaces inherited from interface xyz.xenondevs.invui.gui.Gui.Builder

Gui.Builder.Normal

Field Summary

Fields

Modifier and Type	Field	Description
protected ItemProvider	background	The background ItemProvider of the AbstractGui being built.
protected boolean	frozen	The AbstractGui.frozen state of the AbstractGui being built.
protected boolean	ignoreObscuredInventorySlots	The AbstractGui.ignoreObscuredInventorySlots state of the AbstractGui being built.
protected List<Consumer<G>>	modifiers	A list of Consumers that will be run after the AbstractGui has been built.
protected Structure	structure	The structure of the AbstractGui being built.

Constructor Summary

Constructors

Constructor	Description
AbstractBuilder()

Method Summary

Modifier and Type	Method	Description
S	addIngredient(char key, @NotNull Supplier<? extends Item> itemSupplier)	Adds a Supplier of Items ingredient under the given key.
S	addIngredient(char key, @NotNull org.bukkit.inventory.ItemStack itemStack)	Adds an ItemStack ingredient under the given key.
S	addIngredient(char key, @NotNull SlotElement element)	Adds a SlotElement ingredient under the given key.
S	addIngredient(char key, @NotNull Marker marker)	Adds a Marker ingredient under the given key.
S	addIngredient(char key, @NotNull Inventory inventory)	Adds an Inventory ingredient under the given key.
S	addIngredient(char key, @NotNull Inventory inventory, @Nullable ItemProvider background)	Adds an Inventory ingredient under the given key.
S	addIngredient(char key, @NotNull Item item)	Adds an Item ingredient under the given key.
S	addIngredient(char key, @NotNull ItemProvider itemProvider)	Adds an ItemProvider ingredient under the given key.
S	addIngredientElementSupplier(char key, @NotNull Supplier<? extends SlotElement> elementSupplier)	Adds a Supplier of SlotElements ingredient under the given key.
S	addModifier(@NotNull Consumer<@NotNull G> modifier)	Sets the background of the Gui.
protected void	applyModifiers(G gui)	Applies the modifiers to the given AbstractGui.
S	clone()	Clones the Gui Builder.
S	setBackground(@NotNull org.bukkit.inventory.ItemStack itemStack)	Sets the background of the Gui.
S	setBackground(@NotNull ItemProvider itemProvider)	Sets the background of the Gui.
S	setFrozen(boolean frozen)	Sets whether the Gui should be frozen.
S	setIgnoreObscuredInventorySlots(boolean ignoreObscuredInventorySlots)	Sets whether it is possible to shift-click items into and cursor collect items from all Inventory slots of partially obscured embedded Inventories.
S	setModifiers(@NotNull List<@NotNull Consumer<@NotNull G>> modifiers)	Sets the background of the Gui.
S	setStructure(int width, int height, @NotNull String structureData)	Sets the Structure of the Gui using the given structure data, width and height.
S	setStructure(@NotNull String... structureData)	Sets the Structure of the Gui using the given structure data Strings.
S	setStructure(@NotNull Structure structure)	Sets the Structure of the Gui.

Methods inherited from class java.lang.Object

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

Methods inherited from interface xyz.xenondevs.invui.gui.Gui.Builder

build

Field Details

structure

protected Structure structure

The structure of the AbstractGui being built.

background

protected ItemProvider background

The background ItemProvider of the AbstractGui being built.

modifiers

protected List<Consumer<G extends Gui>> modifiers

A list of Consumers that will be run after the AbstractGui has been built.

frozen

protected boolean frozen

The AbstractGui.frozen state of the AbstractGui being built.

ignoreObscuredInventorySlots

protected boolean ignoreObscuredInventorySlots

The AbstractGui.ignoreObscuredInventorySlots state of the AbstractGui being built.

Constructor Details

AbstractBuilder

public AbstractBuilder()

Method Details

setStructure

@NotNull
public S setStructure(int width,
 int height,
 @NotNull
 @NotNull String structureData)

Description copied from interface: Gui.Builder

Sets the Structure of the Gui using the given structure data, width and height.

Specified by:

setStructure in interface Gui.Builder<G extends Gui,S extends Gui.Builder<G,S>>

Parameters:

width - The width of the Gui

height - The height of the Gui

structureData - The structure data

Returns:

This Gui Builder

setStructure

@NotNull
public S setStructure(@NotNull
 @NotNull String... structureData)

Description copied from interface: Gui.Builder

Sets the Structure of the Gui using the given structure data Strings. Each String is interpreted as a row of the Gui. All Strings must have the same length.

Specified by:

setStructure in interface Gui.Builder<G extends Gui,S extends Gui.Builder<G,S>>

Parameters:

structureData - The structure data

Returns:

This Gui Builder

setStructure

@NotNull
public S setStructure(@NotNull
 @NotNull Structure structure)

Description copied from interface: Gui.Builder

Sets the Structure of the Gui.

Specified by:

setStructure in interface Gui.Builder<G extends Gui,S extends Gui.Builder<G,S>>

Parameters:

structure - The Structure of the Gui

Returns:

This Gui.Builder

addIngredient

@NotNull
public S addIngredient(char key,
 @NotNull
 @NotNull org.bukkit.inventory.ItemStack itemStack)

Description copied from interface: Gui.Builder

Adds an ItemStack ingredient under the given key.

Specified by:

addIngredient in interface Gui.Builder<G extends Gui,S extends Gui.Builder<G,S>>

Parameters:

key - The key

itemStack - The ItemStack

Returns:

This Gui Builder

addIngredient

@NotNull
public S addIngredient(char key,
 @NotNull
 @NotNull ItemProvider itemProvider)

Description copied from interface: Gui.Builder

Adds an ItemProvider ingredient under the given key.

Specified by:

addIngredient in interface Gui.Builder<G extends Gui,S extends Gui.Builder<G,S>>

Parameters:

key - The key

itemProvider - The ItemProvider

Returns:

This Gui Builder

addIngredient

@NotNull
public S addIngredient(char key,
 @NotNull
 @NotNull Item item)

Description copied from interface: Gui.Builder

Adds an Item ingredient under the given key.

Specified by:

addIngredient in interface Gui.Builder<G extends Gui,S extends Gui.Builder<G,S>>

Parameters:

key - The key

item - The Item

Returns:

This Gui Builder

addIngredient

@NotNull
public S addIngredient(char key,
 @NotNull
 @NotNull Inventory inventory)

Description copied from interface: Gui.Builder

Adds an Inventory ingredient under the given key.

Specified by:

addIngredient in interface Gui.Builder<G extends Gui,S extends Gui.Builder<G,S>>

Parameters:

key - The key

inventory - The Inventory

Returns:

This Gui Builder

addIngredient

@NotNull
public S addIngredient(char key,
 @NotNull
 @NotNull Inventory inventory,
 @Nullable
 @Nullable ItemProvider background)

Description copied from interface: Gui.Builder

Adds an Inventory ingredient under the given key.

Specified by:

addIngredient in interface Gui.Builder<G extends Gui,S extends Gui.Builder<G,S>>

Parameters:

key - The key

inventory - The Inventory

background - The ItemProvider for empty slots of the Inventory

Returns:

This Gui Builder

addIngredient

@NotNull
public S addIngredient(char key,
 @NotNull
 @NotNull SlotElement element)

Description copied from interface: Gui.Builder

Adds a SlotElement ingredient under the given key.

Specified by:

addIngredient in interface Gui.Builder<G extends Gui,S extends Gui.Builder<G,S>>

Parameters:

key - The key

element - The SlotElement

Returns:

This Gui Builder

addIngredient

@NotNull
public S addIngredient(char key,
 @NotNull
 @NotNull Marker marker)

Description copied from interface: Gui.Builder

Adds a Marker ingredient under the given key.

Specified by:

addIngredient in interface Gui.Builder<G extends Gui,S extends Gui.Builder<G,S>>

Parameters:

key - The key

marker - The Marker

Returns:

This Gui Builder

addIngredient

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

Description copied from interface: Gui.Builder

Adds a Supplier of Items ingredient under the given key.

Specified by:

addIngredient in interface Gui.Builder<G extends Gui,S extends Gui.Builder<G,S>>

Parameters:

key - The key

itemSupplier - The Supplier of Items

Returns:

This Gui Builder

addIngredientElementSupplier

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

Description copied from interface: Gui.Builder

Adds a Supplier of SlotElements ingredient under the given key.

Specified by:

addIngredientElementSupplier in interface Gui.Builder<G extends Gui,S extends Gui.Builder<G,S>>

Parameters:

key - The key

elementSupplier - The Supplier of SlotElements

Returns:

This Gui Builder

setBackground

@NotNull
public S setBackground(@NotNull
 @NotNull ItemProvider itemProvider)

Description copied from interface: Gui.Builder

Sets the background of the Gui.

Specified by:

setBackground in interface Gui.Builder<G extends Gui,S extends Gui.Builder<G,S>>

Parameters:

itemProvider - The ItemProvider for the background

Returns:

This Gui Builder

setBackground

@NotNull
public S setBackground(@NotNull
 @NotNull org.bukkit.inventory.ItemStack itemStack)

Description copied from interface: Gui.Builder

Sets the background of the Gui.

Specified by:

setBackground in interface Gui.Builder<G extends Gui,S extends Gui.Builder<G,S>>

Parameters:

itemStack - The ItemStack for the background

Returns:

This Gui Builder

setFrozen

@NotNull
public S setFrozen(boolean frozen)

Description copied from interface: Gui.Builder

Sets whether the Gui should be frozen.

Specified by:

setFrozen in interface Gui.Builder<G extends Gui,S extends Gui.Builder<G,S>>

Parameters:

frozen - Whether the Gui should be frozen

Returns:

This Gui Builder

setIgnoreObscuredInventorySlots

@NotNull
public S setIgnoreObscuredInventorySlots(boolean ignoreObscuredInventorySlots)

Description copied from interface: Gui.Builder

Sets whether it is possible to shift-click items into and cursor collect items from all Inventory slots of partially obscured embedded Inventories.

Specified by:

setIgnoreObscuredInventorySlots in interface Gui.Builder<G extends Gui,S extends Gui.Builder<G,S>>

Parameters:

ignoreObscuredInventorySlots - Whether obscured Inventory slots should be ignored when shift-clicking and collecting to the cursor.

Returns:

This Gui Builder

addModifier

@NotNull
public S addModifier(@NotNull
 @NotNull Consumer<@NotNull G> modifier)

Description copied from interface: Gui.Builder

Sets the background of the Gui.

Specified by:

addModifier in interface Gui.Builder<G extends Gui,S extends Gui.Builder<G,S>>

Parameters:

modifier - The Consumer for the background

Returns:

This Gui Builder

setModifiers

@NotNull
public S setModifiers(@NotNull
 @NotNull List<@NotNull Consumer<@NotNull G>> modifiers)

Description copied from interface: Gui.Builder

Sets the background of the Gui.

Specified by:

setModifiers in interface Gui.Builder<G extends Gui,S extends Gui.Builder<G,S>>

Parameters:

modifiers - The Consumers for the background

Returns:

This Gui Builder

applyModifiers

protected void applyModifiers(@NotNull
 G gui)

Applies the modifiers to the given AbstractGui.

Parameters:

gui - The AbstractGui to apply the modifiers to

clone

@NotNull
public S clone()

Description copied from interface: Gui.Builder

Clones the Gui Builder.

Specified by:

clone in interface Gui.Builder<G extends Gui,S extends Gui.Builder<G,S>>

Overrides:

clone in class Object

Returns:

The cloned Gui Builder