com.github.stefvanschie.inventoryframework

Class GuiItem

java.lang.Object

com.github.stefvanschie.inventoryframework.GuiItem

public class GuiItem
extends Object

An item for in an inventory

Constructor Summary

Constructors

Constructor and Description
GuiItem(org.bukkit.inventory.ItemStack item) Creates a new gui item based on the item stack and action
GuiItem(org.bukkit.inventory.ItemStack item, Consumer<org.bukkit.event.inventory.InventoryClickEvent> action) Creates a new gui item based on the item stack and action

Method Summary

Modifier and Type	Method and Description
Consumer<org.bukkit.event.inventory.InventoryClickEvent>	getAction() Returns the action for this item
org.bukkit.inventory.ItemStack	getItem() Returns the item
boolean	isVisible() Returns whether or not this item is visible
void	setVisible(boolean visible) Sets the visibility of this item to the new visibility

Methods inherited from class java.lang.Object

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

Constructor Detail

GuiItem

public GuiItem(@NotNull
               org.bukkit.inventory.ItemStack item,
               @Nullable
               Consumer<org.bukkit.event.inventory.InventoryClickEvent> action)

Creates a new gui item based on the item stack and action

Parameters:

item - the item stack

action - the action called whenever an interaction with this item happens

GuiItem

public GuiItem(@NotNull
               org.bukkit.inventory.ItemStack item)

Creates a new gui item based on the item stack and action

Parameters:

item - the item stack

Method Detail

getAction

@Nullable
 @Contract(pure=true)
public Consumer<org.bukkit.event.inventory.InventoryClickEvent> getAction()

Returns the action for this item

Returns:

the action called when clicked on this item

getItem

@NotNull
 @Contract(pure=true)
public org.bukkit.inventory.ItemStack getItem()

Returns the item

Returns:

the item that belongs to this gui item

isVisible

public boolean isVisible()

Returns whether or not this item is visible

Returns:

true if this item is visible, false otherwise

setVisible

public void setVisible(boolean visible)

Sets the visibility of this item to the new visibility

Parameters:

visible - the new visibility