Package io.github.viimeinen1.ainventory

Class aInventory

java.lang.Object

io.github.viimeinen1.ainventory.aInventory

All Implemented Interfaces:

org.bukkit.inventory.InventoryHolder

Direct Known Subclasses:

aGUIInventory

public class aInventory
extends Object
implements org.bukkit.inventory.InventoryHolder

Custom inventory with addinational features like reloading individual slots.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	aInventory.aItemBuilder	Item builder for aInventory.
static class	aInventory.Builder<T extends aInventory.Builder<T,K>,K extends aInventory>	Custom inventory builder.
static class	aInventory.DefaultBuilder	Default inventory builder.
static enum	aInventory.INVENTORY_SIZE	Possible inventory sizes
static interface	aInventory.inventoryCloseFunction	Inventory close function
static interface	aInventory.inventoryFunction	Generic inventory function.
static interface	aInventory.inventoryOpenFunction
static interface	aInventory.itemClickFunction	click function
static interface	aInventory.itemReloadFunction	Single item reload function
final class	aInventory.Messages	Messages of inventory.
static interface	aInventory.requirementFunction	Inventory use requirement function

Field Summary

Fields

Modifier and Type	Field	Description
final Map<Integer,aInventory.itemClickFunction>	clickFunctions	All slot functions of this inventory.
final org.bukkit.inventory.Inventory	inventory	Inventory of this aInventory.
final Map<Integer,aInventory.itemReloadFunction>	itemReloads	All reload functions of this inventory.
UUID	owner	Owner of the inventory.

Constructor Summary

Constructors

Constructor	Description
aInventory(aInventory.Builder<?,?> builder)	Create new aInventory.

Method Summary

Modifier and Type	Method	Description
static aInventory.DefaultBuilder	builder()	Create new aInventory.DefaultBuilder for building new inventory.
org.bukkit.inventory.Inventory	getInventory()	Get Inventory
aInventory	initialize()	Re-Initialize inventory.
static void	initializeListener(@NotNull org.bukkit.plugin.java.JavaPlugin plugin)	Initialize listener for aInventory.
aInventory.aItemBuilder	ItemBuilder(@org.jetbrains.annotations.NotNull int slot)	Modify slot.
aInventory.aItemBuilder	ItemBuilder(@NotNull Collection<Integer> slots)	Modify multiple slots.
void	onInventoryClick(@NotNull org.bukkit.event.inventory.InventoryClickEvent event)
void	onInventoryClose(@NotNull org.bukkit.event.inventory.InventoryCloseEvent event)
void	onInventoryOpen(@NotNull org.bukkit.event.inventory.InventoryOpenEvent event)
void	onInventoryTransfer(@NotNull org.bukkit.event.inventory.InventoryClickEvent event)
boolean	openInventory(@NotNull org.bukkit.entity.HumanEntity player)	Open inventory for player.
aInventory	reload()	Runs reload function of all slots in the inventory.
aInventory	reload(@NotNull Integer slot)	Runs reload function for specific slot.
aInventory	update()	Update inventory for all it's viewers.

Methods inherited from class java.lang.Object

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

Field Details

inventory

public final org.bukkit.inventory.Inventory inventory

Inventory of this aInventory. Modify this if more control is needed.

owner

public UUID owner

Owner of the inventory. If set, no other player can open or use the inventory.

clickFunctions

public final Map<Integer,aInventory.itemClickFunction> clickFunctions

All slot functions of this inventory.

itemReloads

public final Map<Integer,aInventory.itemReloadFunction> itemReloads

All reload functions of this inventory.

Constructor Details

aInventory

@Internal
public aInventory(aInventory.Builder<?,?> builder)

Create new aInventory. Prefer aInventory.Builder.build() to build new inventory.

Parameters:

builder - extends aInventory.Builder

Method Details

getInventory

public org.bukkit.inventory.Inventory getInventory()

Get Inventory

Specified by:

getInventory in interface org.bukkit.inventory.InventoryHolder

openInventory

public boolean openInventory(@NotNull
 @NotNull org.bukkit.entity.HumanEntity player)

Open inventory for player. Will send aInventory.Messages.NO_OPEN_PERMISSION if no permission to open inventory. Permission will be determined by: - Checking if player UUID matches the owner of the inventory. - Running aInventory.requirementFunction linked to this inventory. Will also reload the inventory before it's openend.

Parameters:

player - Who the inventory will be opened to.

Returns:

true if inventory was opened for player.

initialize

public aInventory initialize()

Re-Initialize inventory. Will: - clear inventory. - run initialization function again. - update inventory to all it's viewers.

Returns:

aInventory

reload

public aInventory reload()

Runs reload function of all slots in the inventory.

Returns:

aInventory

reload

public aInventory reload(@NotNull
 @NotNull Integer slot)

Runs reload function for specific slot.

Parameters:

slot - slot to run reload on

Returns:

aInventory

onInventoryClick

@Internal
public void onInventoryClick(@NotNull
 @NotNull org.bukkit.event.inventory.InventoryClickEvent event)

onInventoryTransfer

@Internal
public void onInventoryTransfer(@NotNull
 @NotNull org.bukkit.event.inventory.InventoryClickEvent event)

onInventoryOpen

@Internal
public void onInventoryOpen(@NotNull
 @NotNull org.bukkit.event.inventory.InventoryOpenEvent event)

onInventoryClose

@Internal
public void onInventoryClose(@NotNull
 @NotNull org.bukkit.event.inventory.InventoryCloseEvent event)

update

public aInventory update()

Update inventory for all it's viewers.

Returns:

aInventory

builder

public static aInventory.DefaultBuilder builder()

Create new aInventory.DefaultBuilder for building new inventory.

Returns:

new aInventory.DefaultBuilder

ItemBuilder

public aInventory.aItemBuilder ItemBuilder(@NotNull
 @org.jetbrains.annotations.NotNull int slot)

Modify slot.

Parameters:

slot - slot number

Returns:

new item builder

ItemBuilder

public aInventory.aItemBuilder ItemBuilder(@NotNull
 @NotNull Collection<Integer> slots)

Modify multiple slots. All previous parameters will be taken from the first item in the list and copied to all slots. (name, lore, amount, material etc.)

Parameters:

slots - slot numbers

Returns:

new item builder

initializeListener

public static void initializeListener(@NotNull
 @NotNull org.bukkit.plugin.java.JavaPlugin plugin)

Initialize listener for aInventory. Without initializing the listener, the click functions will not work.

Parameters:

plugin - JavaPlugin that the listener will be listed for.