Package com.github.darksoulq.abyssallib.world.gui

Enum Class GuiFlag

java.lang.Object

java.lang.Enum<GuiFlag>

com.github.darksoulq.abyssallib.world.gui.GuiFlag

All Implemented Interfaces:

Serializable, Comparable<GuiFlag>, Constable

public enum GuiFlag
extends Enum<GuiFlag>

Flags used to configure and restrict the behavior of a Gui.

These constants are checked by the GUI event system to determine whether certain interactions should be handled by the API, ignored, or blocked entirely.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
DISABLE_ADVANCEMENTS	Prevents the player from progressing in or being granted advancement criteria while this GUI is open.
DISABLE_BOTTOM	Instructs the GUI API to ignore all interactions in the bottom (player) inventory.
DISABLE_ITEM_PICKUP	Prevents the player from picking up items from the ground while this GUI is open.
DISABLE_TOP	Instructs the GUI API to ignore all interactions in the top (menu) inventory.

Method Summary

Modifier and Type	Method	Description
static GuiFlag	valueOf(String name)	Returns the enum constant of this class with the specified name.
static GuiFlag[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, describeConstable, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

DISABLE_TOP

public static final GuiFlag DISABLE_TOP

Instructs the GUI API to ignore all interactions in the top (menu) inventory.

When set, the GuiElement.onClick(com.github.darksoulq.abyssallib.world.gui.GuiView, int, org.bukkit.event.inventory.ClickType, org.bukkit.inventory.ItemStack, org.bukkit.inventory.ItemStack) and GuiElement.onDrag(com.github.darksoulq.abyssallib.world.gui.GuiView, java.util.Map<java.lang.Integer, org.bukkit.inventory.ItemStack>) handlers will not be triggered for the top segment, allowing for vanilla-default behavior or custom external handling.

DISABLE_BOTTOM

public static final GuiFlag DISABLE_BOTTOM

Instructs the GUI API to ignore all interactions in the bottom (player) inventory.

When set, elements defined for the player's inventory will not have their interaction handlers executed.

DISABLE_ITEM_PICKUP

public static final GuiFlag DISABLE_ITEM_PICKUP

Prevents the player from picking up items from the ground while this GUI is open.

DISABLE_ADVANCEMENTS

public static final GuiFlag DISABLE_ADVANCEMENTS

Prevents the player from progressing in or being granted advancement criteria while this GUI is open.

Method Details

values

public static GuiFlag[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static GuiFlag valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null