Class BeaconGui

java.lang.Object

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

com.github.stefvanschie.inventoryframework.gui.type.BeaconGui

All Implemented Interfaces:

InventoryBased, InventoryHolder

public class BeaconGui
extends Gui
implements InventoryBased

Represents a gui in the form of a beacon

Since:

0.8.0

Field Summary

Fields inherited from class Gui

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

Constructor Summary

Constructors

Constructor	Description
BeaconGui()	Constructs a new beacon gui.
BeaconGui(@NotNull Plugin plugin)	Constructs a new beacon gui for the given plugin.

Method Summary

Modifier and Type	Method	Description
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 BeaconGui	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 Iterable<? extends GuiItem>	getItems()	Gets all the GuiItem instances in this gui.
@NotNull GuiComponent	getPaymentItemComponent()	Gets the gui component representing the payment item
@NotNull GuiComponent	getPlayerGuiComponent()	Gets the giu component representing the player inventory
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 BeaconGui	load(@NotNull Object instance, @NotNull InputStream inputStream)	Loads a beacon gui from an XML file.
static @Nullable BeaconGui	load(@NotNull Object instance, @NotNull InputStream inputStream, @NotNull Plugin plugin)	Loads a beacon gui from an XML file.
static @NotNull BeaconGui	load(@NotNull Object instance, @NotNull Element element)	Loads a beacon gui from the specified element, applying code references to the provided instance.
static @NotNull BeaconGui	load(@NotNull Object instance, @NotNull Element element, @NotNull Plugin plugin)	Loads a beacon gui from the specified element, applying code references to the provided instance.
void	show(@NotNull HumanEntity humanEntity)	Shows a gui to a player
void	update()	Update the gui for everyone

Methods inherited from class Gui

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

Methods inherited from class Object

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

Constructor Details

BeaconGui

public BeaconGui()

Constructs a new beacon gui.

Since:

0.8.0

BeaconGui

public BeaconGui(@NotNull
 @NotNull Plugin plugin)

Constructs a new beacon gui for the given plugin.

Parameters:

plugin - the owning plugin of this gui

Since:

0.10.8

See Also:

• BeaconGui()

Method Details

update

public void update()

Description copied from class: Gui

Update the gui for everyone

Specified by:

update in class Gui

getItems

@NotNull
@Contract(pure=true)
public @NotNull Iterable<? extends GuiItem> getItems()

Description copied from class: Gui

Gets all the GuiItem instances in this gui.

Specified by:

getItems in class Gui

Returns:

all gui items

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 BeaconGui 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

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

getInventory

@NotNull
public @NotNull Inventory getInventory()

Specified by:

getInventory in interface InventoryHolder

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

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()

getPaymentItemComponent

@NotNull
@Contract(pure=true)
public @NotNull GuiComponent getPaymentItemComponent()

Gets the gui component representing the payment item

Returns:

the payment item component

Since:

0.8.0

getPlayerGuiComponent

@NotNull
@Contract(pure=true)
public @NotNull GuiComponent getPlayerGuiComponent()

Gets the giu component representing the player inventory

Returns:

the player gui component

Since:

0.8.0

load

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

Loads a beacon 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 beacon gui

Since:

0.10.8

See Also:

• load(Object, InputStream)

load

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

Loads a beacon 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 beacon gui

Since:

0.10.8

See Also:

• load(Object, Element)

load

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

Loads a beacon 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 beacon gui

Since:

0.8.0

load

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

Loads a beacon 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 beacon gui

Since:

0.8.0