me.lucko.helper.menu

Interface Slot

All Known Implementing Classes:

DummySlot, SimpleSlot

public interface Slot

Represents a slot in a Gui. All changes made to this object are applied to the backing Gui instance, and vice versa.

Method Summary

Modifier and Type	Method and Description
Slot	applyFromItem(Item item) Applies an item model to this slot.
Slot	bind(org.bukkit.event.inventory.ClickType type, Consumer<org.bukkit.event.inventory.InventoryClickEvent> handler)
Slot	bind(org.bukkit.event.inventory.ClickType type, Runnable handler)
Slot	bind(Consumer<org.bukkit.event.inventory.InventoryClickEvent> handler, org.bukkit.event.inventory.ClickType... types)
Slot	bind(Runnable handler, org.bukkit.event.inventory.ClickType... types)
<T extends Consumer<org.bukkit.event.inventory.InventoryClickEvent>> Slot	bindAllConsumers(Iterable<Map.Entry<org.bukkit.event.inventory.ClickType,T>> handlers)
<T extends Runnable> Slot	bindAllRunnables(Iterable<Map.Entry<org.bukkit.event.inventory.ClickType,T>> handlers)
Slot	clear() Clears all attributes of the slot.
Slot	clearBindings() Clears all bindings on this slot.
Slot	clearBindings(org.bukkit.event.inventory.ClickType type) Clears all bindings on this slot for a given click type.
Slot	clearItem() Clears the item in this slot
int	getId() Gets the id of this slot
org.bukkit.inventory.ItemStack	getItem() Gets the item in this slot
Gui	gui() Gets the GUI this slot references
boolean	hasItem() Gets if this slot has an item
Slot	setItem(org.bukkit.inventory.ItemStack item) Sets the item in this slot

Method Detail

gui

@Nonnull
Gui gui()

Gets the GUI this slot references

Returns:

the parent gui

getId

int getId()

Gets the id of this slot

Returns:

the id

applyFromItem

Slot applyFromItem(Item item)

Applies an item model to this slot.

Parameters:

item - the item

Returns:

this slot

getItem

@Nullable
org.bukkit.inventory.ItemStack getItem()

Gets the item in this slot

Returns:

the item in this slot

hasItem

boolean hasItem()

Gets if this slot has an item

Returns:

true if this slot has an item

setItem

@Nonnull
Slot setItem(@Nonnull
                      org.bukkit.inventory.ItemStack item)

Sets the item in this slot

Parameters:

item - the new item

Returns:

this slot

clear

Slot clear()

Clears all attributes of the slot.

Returns:

this slot

clearItem

@Nonnull
Slot clearItem()

Clears the item in this slot

Returns:

this slot

clearBindings

@Nonnull
Slot clearBindings()

Clears all bindings on this slot.

Returns:

this slot

clearBindings

@Nonnull
Slot clearBindings(org.bukkit.event.inventory.ClickType type)

Clears all bindings on this slot for a given click type.

Returns:

this slot

bind

@Nonnull
Slot bind(@Nonnull
                   org.bukkit.event.inventory.ClickType type,
                   @Nonnull
                   Consumer<org.bukkit.event.inventory.InventoryClickEvent> handler)

bind

@Nonnull
Slot bind(@Nonnull
                   org.bukkit.event.inventory.ClickType type,
                   @Nonnull
                   Runnable handler)

bind

@Nonnull
Slot bind(@Nonnull
                   Consumer<org.bukkit.event.inventory.InventoryClickEvent> handler,
                   @Nonnull
                   org.bukkit.event.inventory.ClickType... types)

bind

@Nonnull
Slot bind(@Nonnull
                   Runnable handler,
                   @Nonnull
                   org.bukkit.event.inventory.ClickType... types)

bindAllRunnables

@Nonnull
<T extends Runnable> Slot bindAllRunnables(@Nonnull
                                                    Iterable<Map.Entry<org.bukkit.event.inventory.ClickType,T>> handlers)

bindAllConsumers

@Nonnull
<T extends Consumer<org.bukkit.event.inventory.InventoryClickEvent>> Slot bindAllConsumers(@Nonnull
                                                                                                    Iterable<Map.Entry<org.bukkit.event.inventory.ClickType,T>> handlers)