pl.isangeles.senlin.core

Class Inventory

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractList<E>

java.util.AbstractSequentialList<E>

java.util.LinkedList<Item>

pl.isangeles.senlin.core.Inventory

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, java.lang.Iterable<Item>, java.util.Collection<Item>, java.util.Deque<Item>, java.util.List<Item>, java.util.Queue<Item>, SaveElement

public final class Inventory
extends java.util.LinkedList<Item>
implements SaveElement

Class for character inventory, contains all player items

Author:

Isangeles

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Inventory(Targetable character) Inventory constructor
Inventory(Targetable character, InventoryLock lock) Inventory constructor, with lock

Method Summary

Modifier and Type	Method and Description
boolean	add(Item item) Adds item to inventory
boolean	addAll(java.util.Collection<? extends Item> items) Adds all items from collection to inventory
boolean	addAll(Item[] items) Adds all items from collection to inventory
java.util.List<SlotContent>	asSlotsContent() Returns all inventory as list with slot content
boolean	equip(Item item) Equips specified item, if item is in character inventory and its equippable
Item	get(int index) Returns item with specific index in inventory container
int	getArmorRating() Returns armor rating of equipped items
int	getCashValue() Returns value of all coins in this inventory
Armor	getChest() Return character chest
java.util.Collection<Item>	getCoins() Returns all coins in inventory
Armor	getHelmet() Return character helmet
Item	getItem(java.lang.String itemId) Returns item which matches to specific id
Item	getItemBySerial(java.lang.String serialId) Returns item with specified serial ID
java.util.Collection<Item>	getItems(java.lang.String id) Returns all items with specified ID from inventory
java.util.Collection<Item>	getItems(java.lang.String id, int amount) Returns specified amount of items with specified ID
Weapon	getMainWeapon() Return character main weapon
Weapon	getOffHand() Returns character off hand
org.w3c.dom.Element	getSave(org.w3c.dom.Document doc) Parses inventory to XML document element
org.w3c.dom.Element	getSaveWithoutEq(org.w3c.dom.Document doc) Parses inventory without equipment to XML document element
int[]	getWeaponDamage() Returns weapon damage of equipment items
java.util.List<Item>	getWithoutEq() Returns all items except equipped items
boolean	isDualwield() Checks if both main and off weapon are equipped
boolean	isEquipped(Item item) Checks if specified item is equipped
boolean	isLocked() Checks if inventory is locked
void	lock(InventoryLock lock) Lock inventory with specified lock
boolean	remove(java.lang.Object item) Removes specified item from inventory
boolean	remove(java.lang.String serialId) Removes items with specified serial ID from inventory
boolean	remove(java.lang.String id, int amount) Removes specified amount of items with specified ID from inventory
boolean	removeAll(java.util.Collection<?> items)
boolean	takeCash(int value) Takes amount of coins with specified value from inventory
Item	takeItem(Item item) Removes specified item from inventory and returns it
Item	takeItem(java.lang.String itemId) Removes item with specified ID from inventory and returns it
void	unequipp(Equippable item) Removes specific item from equippment
boolean	unlock(Character character) Opens lock
boolean	unlock(UnlockBonus skill) Opens lock with specified skill
void	update() Updates inventory (for example bonuses from equipped items)

Methods inherited from class java.util.LinkedList

add, addAll, addFirst, addLast, clear, clone, contains, descendingIterator, element, getFirst, getLast, indexOf, lastIndexOf, listIterator, offer, offerFirst, offerLast, peek, peekFirst, peekLast, poll, pollFirst, pollLast, pop, push, remove, remove, removeFirst, removeFirstOccurrence, removeLast, removeLastOccurrence, set, size, spliterator, toArray, toArray

Methods inherited from class java.util.AbstractSequentialList

iterator

Methods inherited from class java.util.AbstractList

equals, hashCode, listIterator, subList

Methods inherited from class java.util.AbstractCollection

containsAll, isEmpty, retainAll, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.List

containsAll, equals, hashCode, isEmpty, iterator, listIterator, replaceAll, retainAll, sort, subList

Methods inherited from interface java.util.Deque

iterator

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream

Methods inherited from interface java.lang.Iterable

forEach

Constructor Detail

Inventory

public Inventory(Targetable character)

Inventory constructor

Parameters:

character - Inventory owner

Inventory

public Inventory(Targetable character,
                 InventoryLock lock)

Inventory constructor, with lock

Parameters:

character - Inventory owner

lock - Inventory lock

Method Detail

update

public void update()

Updates inventory (for example bonuses from equipped items)

add

public boolean add(Item item)

Adds item to inventory

Specified by:

add in interface java.util.Collection<Item>

Specified by:

add in interface java.util.Deque<Item>

Specified by:

add in interface java.util.List<Item>

Specified by:

add in interface java.util.Queue<Item>

Overrides:

add in class java.util.LinkedList<Item>

Returns:

True if item successfully added, false otherwise

addAll

public boolean addAll(java.util.Collection<? extends Item> items)

Adds all items from collection to inventory

Specified by:

addAll in interface java.util.Collection<Item>

Specified by:

addAll in interface java.util.List<Item>

Overrides:

addAll in class java.util.LinkedList<Item>

Parameters:

items - Collection with items

Returns:

True if all items was added successfully, false if at least one wasn't added

addAll

public boolean addAll(Item[] items)

Adds all items from collection to inventory

Parameters:

items - Collection with items

Returns:

True if all items was added successfully, false if at least one wasn't added

remove

public boolean remove(java.lang.Object item)

Removes specified item from inventory

Specified by:

remove in interface java.util.Collection<Item>

Specified by:

remove in interface java.util.Deque<Item>

Specified by:

remove in interface java.util.List<Item>

Overrides:

remove in class java.util.LinkedList<Item>

Parameters:

item - Game item

Returns:

True if item was successfully removed, false otherwise

remove

public boolean remove(java.lang.String serialId)

Removes items with specified serial ID from inventory

Parameters:

serialId - Serial ID of item to remove

Returns:

True if item was successfully removed, false otherwise

remove

public boolean remove(java.lang.String id,
                      int amount)

Removes specified amount of items with specified ID from inventory

Parameters:

serialId - ID of items to remove

Returns:

True if specified amount of items was successfully removed, false otherwise

removeAll

public boolean removeAll(java.util.Collection<?> items)

Specified by:

removeAll in interface java.util.Collection<Item>

Specified by:

removeAll in interface java.util.List<Item>

Overrides:

removeAll in class java.util.AbstractCollection<Item>

getCashValue

public int getCashValue()

Returns value of all coins in this inventory

Returns:

Value of coins in inventory

unequipp

public void unequipp(Equippable item)

Removes specific item from equippment

Parameters:

item - Equipped character item

equip

public boolean equip(Item item)

Equips specified item, if item is in character inventory and its equippable

Parameters:

item - Equippable item in character inventory

Returns:

True if item was successfully equipped, false otherwise

isEquipped

public boolean isEquipped(Item item)

Checks if specified item is equipped

Parameters:

item - Game item

Returns:

True if specified item is equipped, false otherwise

getWeaponDamage

public int[] getWeaponDamage()

Returns weapon damage of equipment items

Returns:

Table with minimal[0] and maximal[1] damage

getArmorRating

public int getArmorRating()

Returns armor rating of equipped items

Returns:

Value of armor rating

getHelmet

public Armor getHelmet()

Return character helmet

Returns:

Equipped armor item, type helmet OR null if not equipped

getChest

public Armor getChest()

Return character chest

Returns:

Equipped armor item, type chest OR null if not equipped

getMainWeapon

public Weapon getMainWeapon()

Return character main weapon

Returns:

Equipped main weapon or null if no item equipped

getOffHand

public Weapon getOffHand()

Returns character off hand

Returns:

Equipped secondary weapon or null if no item equipped

getItem

public Item getItem(java.lang.String itemId)

Returns item which matches to specific id

Parameters:

itemId - Id of requested item

Returns:

Item with specific id or error item if item was not fund

getItems

public java.util.Collection<Item> getItems(java.lang.String id,
                                           int amount)

Returns specified amount of items with specified ID

Parameters:

id - Items ID

amount - Amount of items to return

Returns:

Collection with specified amount of items with specified ID or empty collection if specified amount is too big

getItems

public java.util.Collection<Item> getItems(java.lang.String id)

Returns all items with specified ID from inventory

Parameters:

id - String with items ID

Returns:

Collection with all items with specified ID from inventory

getCoins

public java.util.Collection<Item> getCoins()

Returns all coins in inventory

Returns:

Collections with items

get

public Item get(int index)

Returns item with specific index in inventory container

Specified by:

get in interface java.util.List<Item>

Overrides:

get in class java.util.LinkedList<Item>

Parameters:

index - Index in inventory container

Returns:

Item from inventory container

getItemBySerial

public Item getItemBySerial(java.lang.String serialId)

Returns item with specified serial ID

Parameters:

serialId - String with serial ID

Returns:

Item with specified serial ID or null if item was not found

takeItem

public Item takeItem(Item item)

Removes specified item from inventory and returns it

Parameters:

item - Item in inventory to remove

Returns:

Removed item or null if inventory does not contain that item

takeItem

public Item takeItem(java.lang.String itemId)

Removes item with specified ID from inventory and returns it

Parameters:

item - Item in inventory to remove

Returns:

Removed item or null if inventory does not contain item with such ID

takeCash

public boolean takeCash(int value)

Takes amount of coins with specified value from inventory

Parameters:

value - Value to 'pay' with coins from inventory

Returns:

True if value was successfully 'paid', false if there was no enough coins in inventory

getWithoutEq

public java.util.List<Item> getWithoutEq()

Returns all items except equipped items

Returns:

List with items

asSlotsContent

public java.util.List<SlotContent> asSlotsContent()

Returns all inventory as list with slot content

Returns:

List with slot content

isDualwield

public boolean isDualwield()

Checks if both main and off weapon are equipped

Returns:

True if main and off weapon are equipped

isLocked

public boolean isLocked()

Checks if inventory is locked

Returns:

True if inventory is locked, false otherwise

unlock

public boolean unlock(Character character)

Opens lock

Parameters:

character - Game character opening lock

Returns:

True if lock was successfully opened, false otherwise

unlock

public boolean unlock(UnlockBonus skill)

Opens lock with specified skill

Parameters:

skill - Skill

Returns:

True if lock was successfully opened, false otherwise

lock

public void lock(InventoryLock lock)

Lock inventory with specified lock

Parameters:

lock - Inventory lock

getSave

public org.w3c.dom.Element getSave(org.w3c.dom.Document doc)

Parses inventory to XML document element

Specified by:

getSave in interface SaveElement

Parameters:

doc - Document for save game file

Returns:

XML document element

getSaveWithoutEq

public org.w3c.dom.Element getSaveWithoutEq(org.w3c.dom.Document doc)

Parses inventory without equipment to XML document element

Parameters:

doc - Document for save game file

Returns:

XML document element