Package com.github.stefvanschie.inventoryframework.gui.type

Class BarrelGui

java.lang.Object

com.github.stefvanschie.inventoryframework.gui.type.util.Gui

com.github.stefvanschie.inventoryframework.gui.type.util.NamedGui

com.github.stefvanschie.inventoryframework.gui.type.BarrelGui

All Implemented Interfaces:

InventoryBased, MergedGui, InventoryHolder

public class BarrelGui
extends NamedGui
implements MergedGui, InventoryBased

Represents a gui in the form of a barrel.

Since:

0.8.0

Field Summary

Fields inherited from class com.github.stefvanschie.inventoryframework.gui.type.util.Gui

humanEntityCache, inventory, onBottomClick, onBottomDrag, onClose, onGlobalClick, onGlobalDrag, onOutsideClick, onTopClick, onTopDrag, plugin

Constructor Summary

Constructors

Constructor	Description
BarrelGui(@NotNull com.github.stefvanschie.inventoryframework.adventuresupport.TextHolder title)	Constructs a new GUI
BarrelGui(@NotNull com.github.stefvanschie.inventoryframework.adventuresupport.TextHolder title, @NotNull Plugin plugin)	Constructs a new barrel gui for the given plugin.
BarrelGui(@NotNull String title)	Constructs a new GUI
BarrelGui(@NotNull String title, @NotNull Plugin plugin)	Constructs a new barrel gui for the given plugin.

Method Summary

Modifier and Type	Method	Description
void	addPane(@NotNull Pane pane)	Adds a pane to this gui
void	click(@NotNull InventoryClickEvent event)	This should delegate the provided inventory click event to the right pane, which can then handle this click event further.
@NotNull BarrelGui	copy()	Makes a copy of this gui and returns it.
@NotNull Inventory	createInventory()	Creates a new inventory of the type of the implementing class.
@NotNull Inventory	getInventory()
@NotNull InventoryComponent	getInventoryComponent()	Gets the inventory component for this gui
@NotNull Collection<GuiItem>	getItems()	Gets all the items in all underlying panes
@NotNull List<Pane>	getPanes()	Gets all the panes in this gui.
int	getViewerCount()	Gets the count of HumanEntity instances that are currently viewing this GUI.
@NotNull List<HumanEntity>	getViewers()	Gets a mutable snapshot of the current HumanEntity viewers of this GUI.
boolean	isPlayerInventoryUsed()	Gets whether the player inventory is currently in use.
static @Nullable BarrelGui	load(@NotNull Object instance, @NotNull InputStream inputStream)	Loads a barrel gui from an XML file.
static @Nullable BarrelGui	load(@NotNull Object instance, @NotNull InputStream inputStream, @NotNull Plugin plugin)	Loads a barrel gui from an XML file.
static @NotNull BarrelGui	load(@NotNull Object instance, @NotNull Element element)	Loads a barrel gui from the specified element, applying code references to the provided instance.
static @NotNull BarrelGui	load(@NotNull Object instance, @NotNull Element element, @NotNull Plugin plugin)	Loads a barrel gui from the specified element, applying code references to the provided instance.
void	show(@NotNull HumanEntity humanEntity)	Shows a gui to a player

Methods inherited from class com.github.stefvanschie.inventoryframework.gui.type.util.NamedGui

getTitle, getTitleHolder, isDirty, markChanges, setTitle, setTitle

Methods inherited from class com.github.stefvanschie.inventoryframework.gui.type.util.Gui

addInventory, callCallback, callOnBottomClick, callOnBottomDrag, callOnClose, callOnGlobalClick, callOnGlobalDrag, callOnOutsideClick, callOnTopClick, callOnTopDrag, getGui, getHumanEntityCache, initializeOrThrow, isUpdating, loadPane, loadPane, registerGui, registerGui, registerPane, registerPane, registerProperty, setOnBottomClick, setOnBottomDrag, setOnClose, setOnGlobalClick, setOnGlobalDrag, setOnOutsideClick, setOnTopClick, setOnTopDrag, update

Methods inherited from class java.lang.Object

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

Constructor Details

BarrelGui

public BarrelGui(@NotNull
 @NotNull String title)

Constructs a new GUI

Parameters:

title - the title/name of this gui.

Since:

0.8.0

BarrelGui

public BarrelGui(@NotNull
 @NotNull com.github.stefvanschie.inventoryframework.adventuresupport.TextHolder title)

Constructs a new GUI

Parameters:

title - the title/name of this gui.

Since:

0.10.0

BarrelGui

public BarrelGui(@NotNull
 @NotNull String title,
 @NotNull
 @NotNull Plugin plugin)

Constructs a new barrel gui for the given plugin.

Parameters:

title - the title/name of this gui.

plugin - the owning plugin of this gui

Since:

0.10.8

See Also:

• BarrelGui(String)

BarrelGui

public BarrelGui(@NotNull
 @NotNull com.github.stefvanschie.inventoryframework.adventuresupport.TextHolder title,
 @NotNull
 @NotNull Plugin plugin)

Constructs a new barrel gui for the given plugin.

Parameters:

title - the title/name of this gui.

plugin - the owning plugin of this gui

Since:

0.10.8

See Also:

• BarrelGui(TextHolder)

Method Details

show

public void show(@NotNull
 @NotNull HumanEntity humanEntity)

Description copied from class: Gui

Shows a gui to a player

Specified by:

show in class Gui

Parameters:

humanEntity - the human entity to show the gui to

copy

@NotNull
@Contract(pure=true)
public @NotNull BarrelGui copy()

Description copied from class: Gui

Makes a copy of this gui and returns it. This makes a deep copy of the gui. This entails that the underlying panes will be copied as per their Pane.copy() and miscellaneous data will be copied. The copy of this gui, will however have no viewers even if this gui currently has viewers. With this, cache data for viewers will also be non-existent for the copied gui. The original owning plugin of the gui is preserved, but the plugin will not be deeply copied. The returned gui will never be reference equal to the current gui.

Specified by:

copy in class Gui

Returns:

a copy of the gui

getInventory

@NotNull
public @NotNull Inventory getInventory()

Specified by:

getInventory in interface InventoryHolder

click

public void click(@NotNull
 @NotNull InventoryClickEvent event)

Description copied from class: Gui

This should delegate the provided inventory click event to the right pane, which can then handle this click event further. This should not call any internal click handlers, since those will already have been activated.

Specified by:

click in class Gui

Parameters:

event - the event to delegate

isPlayerInventoryUsed

@Contract(pure=true)
public boolean isPlayerInventoryUsed()

Description copied from class: Gui

Gets whether the player inventory is currently in use. This means whether the player inventory currently has an item in it.

Specified by:

isPlayerInventoryUsed in class Gui

Returns:

true if the player inventory is occupied, false otherwise

addPane

public void addPane(@NotNull
 @NotNull Pane pane)

Description copied from interface: MergedGui

Adds a pane to this gui

Specified by:

addPane in interface MergedGui

Parameters:

pane - the pane to add

getPanes

@NotNull
@Contract(pure=true)
public @NotNull List<Pane> getPanes()

Description copied from interface: MergedGui

Gets all the panes in this gui. This includes child panes from other panes.

Specified by:

getPanes in interface MergedGui

Returns:

all panes

getItems

@NotNull
@Contract(pure=true)
public @NotNull Collection<GuiItem> getItems()

Description copied from interface: MergedGui

Gets all the items in all underlying panes

Specified by:

getItems in interface MergedGui

Returns:

all items

createInventory

@NotNull
@Contract(pure=true)
public @NotNull Inventory createInventory()

Description copied from interface: InventoryBased

Creates a new inventory of the type of the implementing class.

Specified by:

createInventory in interface InventoryBased

Returns:

the new inventory

getViewerCount

@Contract(pure=true)
public int getViewerCount()

Description copied from class: Gui

Gets the count of HumanEntity instances that are currently viewing this GUI.

Specified by:

getViewerCount in class Gui

Returns:

the count of viewers

getViewers

@NotNull
@Contract(pure=true)
public @NotNull List<HumanEntity> getViewers()

Description copied from class: Gui

Gets a mutable snapshot of the current HumanEntity viewers of this GUI. This is a snapshot (copy) and not a view, therefore modifications aren't visible.

Specified by:

getViewers in class Gui

Returns:

a snapshot of the current viewers

See Also:

• Gui.getViewerCount()

getInventoryComponent

@NotNull
@Contract(pure=true)
public @NotNull InventoryComponent getInventoryComponent()

Description copied from interface: MergedGui

Gets the inventory component for this gui

Specified by:

getInventoryComponent in interface MergedGui

Returns:

the inventory component

load

@Nullable
@Contract(pure=true)
public static @Nullable BarrelGui load(@NotNull
 @NotNull Object instance,
 @NotNull
 @NotNull InputStream inputStream,
 @NotNull
 @NotNull Plugin plugin)

Loads a barrel gui from an XML file.

Parameters:

instance - the instance on which to reference fields and methods

inputStream - the input stream containing the XML data

plugin - the plugin that will be the owner of the created gui

Returns:

the loaded barrel gui

Since:

0.10.8

See Also:

• load(Object, InputStream)

load

@NotNull
public static @NotNull BarrelGui load(@NotNull
 @NotNull Object instance,
 @NotNull
 @NotNull Element element,
 @NotNull
 @NotNull Plugin plugin)

Loads a barrel gui from the specified element, applying code references to the provided instance.

Parameters:

instance - the instance on which to reference fields and methods

element - the element to load the gui from

plugin - the plugin that will be the owner of the created gui

Returns:

the loaded barrel gui

Since:

0.10.8

See Also:

• load(Object, Element)

load

@Nullable
@Contract(pure=true)
public static @Nullable BarrelGui load(@NotNull
 @NotNull Object instance,
 @NotNull
 @NotNull InputStream inputStream)

Loads a barrel gui from an XML file.

Parameters:

instance - the instance on which to reference fields and methods

inputStream - the input stream containing the XML data

Returns:

the loaded barrel gui

Since:

0.8.0

load

@NotNull
public static @NotNull BarrelGui load(@NotNull
 @NotNull Object instance,
 @NotNull
 @NotNull Element element)

Loads a barrel gui from the specified element, applying code references to the provided instance.

Parameters:

instance - the instance on which to reference fields and methods

element - the element to load the gui from

Returns:

the loaded barrel gui

Since:

0.8.0