org.cloudburstmc.server.inventory

Class BaseInventory

java.lang.Object

org.cloudburstmc.server.inventory.BaseInventory

All Implemented Interfaces:

Inventory

Direct Known Subclasses:

ContainerInventory, PlayerEnderChestInventory, PlayerInventory, PlayerUIComponent, PlayerUIInventory

public abstract class BaseInventory
extends Object
implements Inventory

author: MagicDroidX Nukkit Project

Field Summary

Fields

Modifier and Type	Field and Description
protected InventoryHolder	holder
protected int	maxStackSize
protected String	name
protected int	size
Map<Integer,Item>	slots
protected String	title
protected InventoryType	type
protected Set<Player>	viewers

Fields inherited from interface org.cloudburstmc.server.inventory.Inventory

MAX_STACK

Constructor Summary

Constructors

Constructor and Description
BaseInventory(InventoryHolder holder, InventoryType type)
BaseInventory(InventoryHolder holder, InventoryType type, Map<Integer,Item> items)
BaseInventory(InventoryHolder holder, InventoryType type, Map<Integer,Item> items, Integer overrideSize)
BaseInventory(InventoryHolder holder, InventoryType type, Map<Integer,Item> items, Integer overrideSize, String overrideTitle)

Method Summary

Modifier and Type	Method and Description
Item[]	addItem(Item... slots)
Map<Integer,Item>	all(Item item)
boolean	canAddItem(Item item)
boolean	clear(int index, boolean send)
void	clearAll()
void	close(Player who)
boolean	contains(Item item)
void	decreaseCount(int slot) Decrease item count in the given slot
int	first(Item item, boolean exact) Search for the first occurrence of target item
int	firstEmpty() Search for the first empty slot
int	firstFit(Item item, boolean single) Returns the first slot where item fits to
int	firstNonEmpty() Search for the first slot containing an item
Map<Integer,Item>	getContents()
int	getFreeSpace(Item item) Returns how much space remains for the target item
InventoryHolder	getHolder()
Item	getItem(int index)
int	getMaxStackSize()
String	getName()
int	getSize()
String	getTitle()
InventoryType	getType()
Set<Player>	getViewers()
void	increaseCount(int slot) Increase item count in the given slot
boolean	isEmpty()
boolean	isFull()
void	onClose(Player who)
void	onOpen(Player who)
void	onSlotChange(int index, Item before, boolean send)
boolean	open(Player who)
void	remove(Item item)
Item[]	removeItem(Item... slots)
void	sendContents(Collection<Player> players)
void	sendContents(Player... players)
void	sendContents(Player player)
void	sendSlot(int index, Collection<Player> players)
void	sendSlot(int index, Player... players)
void	sendSlot(int index, Player player)
void	setContents(Map<Integer,Item> items)
boolean	setItem(int index, Item item, boolean send)
void	setMaxStackSize(int maxStackSize)
void	setSize(int size)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.cloudburstmc.server.inventory.Inventory

clear, first, firstFit, setItem

Field Detail

type

protected final InventoryType type

maxStackSize

protected int maxStackSize

size

protected int size

name

protected final String name

title

protected final String title

slots

public final Map<Integer,Item> slots

viewers

protected final Set<Player> viewers

holder

protected InventoryHolder holder

Constructor Detail

BaseInventory

public BaseInventory(InventoryHolder holder,
                     InventoryType type)

BaseInventory

public BaseInventory(InventoryHolder holder,
                     InventoryType type,
                     Map<Integer,Item> items)

BaseInventory

public BaseInventory(InventoryHolder holder,
                     InventoryType type,
                     Map<Integer,Item> items,
                     Integer overrideSize)

BaseInventory

public BaseInventory(InventoryHolder holder,
                     InventoryType type,
                     Map<Integer,Item> items,
                     Integer overrideSize,
                     String overrideTitle)

Method Detail

getSize

public int getSize()

Specified by:

getSize in interface Inventory

setSize

public void setSize(int size)

getMaxStackSize

public int getMaxStackSize()

Specified by:

getMaxStackSize in interface Inventory

getName

public String getName()

Specified by:

getName in interface Inventory

getTitle

public String getTitle()

Specified by:

getTitle in interface Inventory

getItem

public Item getItem(int index)

Specified by:

getItem in interface Inventory

getContents

public Map<Integer,Item> getContents()

Specified by:

getContents in interface Inventory

setContents

public void setContents(Map<Integer,Item> items)

Specified by:

setContents in interface Inventory

setItem

public boolean setItem(int index,
                       Item item,
                       boolean send)

Specified by:

setItem in interface Inventory

contains

public boolean contains(Item item)

Specified by:

contains in interface Inventory

all

public Map<Integer,Item> all(Item item)

Specified by:

all in interface Inventory

remove

public void remove(Item item)

Specified by:

remove in interface Inventory

first

public int first(Item item,
                 boolean exact)

Description copied from interface: Inventory

Search for the first occurrence of target item

Specified by:

first in interface Inventory

Parameters:

item - target item

exact - if true the item count will be must match

Returns:

the first index containing the item

firstEmpty

public int firstEmpty()

Description copied from interface: Inventory

Search for the first empty slot

Specified by:

firstEmpty in interface Inventory

Returns:

the first slot index

firstNonEmpty

public int firstNonEmpty()

Description copied from interface: Inventory

Search for the first slot containing an item

Specified by:

firstNonEmpty in interface Inventory

Returns:

the first non-empty slot

firstFit

public int firstFit(Item item,
                    boolean single)

Description copied from interface: Inventory

Returns the first slot where item fits to

Specified by:

firstFit in interface Inventory

Parameters:

item - item to search for

single - if false the item count will be used. Otherwise it'll be 1

Returns:

the first slot index that item fits to

decreaseCount

public void decreaseCount(int slot)

Description copied from interface: Inventory

Decrease item count in the given slot

Specified by:

decreaseCount in interface Inventory

Parameters:

slot - target slot index

increaseCount

public void increaseCount(int slot)

Description copied from interface: Inventory

Increase item count in the given slot

Specified by:

increaseCount in interface Inventory

Parameters:

slot - target slot index

canAddItem

public boolean canAddItem(Item item)

Specified by:

canAddItem in interface Inventory

addItem

public Item[] addItem(Item... slots)

Specified by:

addItem in interface Inventory

removeItem

public Item[] removeItem(Item... slots)

Specified by:

removeItem in interface Inventory

clear

public boolean clear(int index,
                     boolean send)

Specified by:

clear in interface Inventory

clearAll

public void clearAll()

Specified by:

clearAll in interface Inventory

getViewers

public Set<Player> getViewers()

Specified by:

getViewers in interface Inventory

getHolder

public InventoryHolder getHolder()

Specified by:

getHolder in interface Inventory

setMaxStackSize

public void setMaxStackSize(int maxStackSize)

Specified by:

setMaxStackSize in interface Inventory

open

public boolean open(Player who)

Specified by:

open in interface Inventory

close

public void close(Player who)

Specified by:

close in interface Inventory

onOpen

public void onOpen(Player who)

Specified by:

onOpen in interface Inventory

onClose

public void onClose(Player who)

Specified by:

onClose in interface Inventory

onSlotChange

public void onSlotChange(int index,
                         Item before,
                         boolean send)

Specified by:

onSlotChange in interface Inventory

sendContents

public void sendContents(Player player)

Specified by:

sendContents in interface Inventory

sendContents

public void sendContents(Player... players)

Specified by:

sendContents in interface Inventory

isFull

public boolean isFull()

Specified by:

isFull in interface Inventory

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Inventory

getFreeSpace

public int getFreeSpace(Item item)

Description copied from interface: Inventory

Returns how much space remains for the target item

Specified by:

getFreeSpace in interface Inventory

Parameters:

item - target item

Returns:

amount if free space

sendContents

public void sendContents(Collection<Player> players)

Specified by:

sendContents in interface Inventory

sendSlot

public void sendSlot(int index,
                     Player player)

Specified by:

sendSlot in interface Inventory

sendSlot

public void sendSlot(int index,
                     Player... players)

Specified by:

sendSlot in interface Inventory

sendSlot

public void sendSlot(int index,
                     Collection<Player> players)

Specified by:

sendSlot in interface Inventory

getType

public InventoryType getType()

Specified by:

getType in interface Inventory