org.jzuul.engine
Class Inventory

java.lang.Object
  org.jzuul.engine.Inventory

public class Inventory

extends Object

Das Inventar eines Spielers oder eines Raums. Hier werden die aufgenommen GameObjects gehalten. Das Inventar hat eine Grösse. Jedes aufgenomme GameObject belegt Platz im Inventar, so dass nur eine gewisse Anzahl an GameObjects aufgenommen werden kann.

Version:

$Revision: 1.12 $

Field Summary

(package private) int	fillStat Füllstatus des Inventars
protected Map	gameObjectMap Interner Datentyp zum halten der GameObjects HashMap of Stacks
(package private) boolean	isUnlimited Bildet size == UNLIMITED_INVENTORY ab
(package private) int	size Größe des Inventars in Einheiten
static int	UNLIMITED_INVENTORY Größenwert für ein unendlich großes Inventar

Constructor Summary

Inventory(int size)
Konstruktor

Method Summary

boolean	addGameObject(GameObject item) Fügt ein neues Item in das Inventar ein
boolean	contains(List objects)
boolean	contains(String[] objects) Fragt nach ob das Inventar die GameObjects mit den gegebenen Namen enthält
boolean	containsGameObject(String name) Fragt ob das Iventory das GameObject mit dem Namen name enthält
Inventory	copy() Erstellt eine depp copy des aktuellen Inventars
boolean	deleteGameObject(String name) Löscht das Item mit dem Namen name
Iterator	gameObjectNamesIterator() Liefert Iterator über die Namen der Objekt in dem Inventars
List	getCharacterObjects() Sucht alle Character im Inventar
GameObject	getGameObject(String name) Get a GameObject by name
Iterator	getGameObjects() Gibt alle GameObjects im Inventar zurück
int	getNumberOfObject(String name) Fragt nach der Anzahl der Objekte mit dem gegebenen Namen
GameObject	popGameObject(String name) popItem gibt das GameObject mit dem Namen name zurück und entfernt dieses aus dem Inventar
boolean	pushGameObject(GameObject item)
Element	toElement() Wandelt das Inventar in ein JDOM XML Element um.
String	toString() Gibt eine textuelle Beschreibung des Inventars zurück

Methods inherited from class java.lang.Object

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

Field Detail

gameObjectMap

protected Map gameObjectMap

Interner Datentyp zum halten der GameObjects HashMap of Stacks

size

int size

Größe des Inventars in Einheiten

fillStat

int fillStat

Füllstatus des Inventars

isUnlimited

boolean isUnlimited

Bildet size == UNLIMITED_INVENTORY ab

UNLIMITED_INVENTORY

public static int UNLIMITED_INVENTORY

Größenwert für ein unendlich großes Inventar

Constructor Detail

Inventory

public Inventory(int size)

Konstruktor

Parameters:

size - - Die größe des Inventar

Method Detail

addGameObject

public boolean addGameObject(GameObject item)

Fügt ein neues Item in das Inventar ein

Parameters:

item - das Aufgenommen werden soll

Returns:

Erfolgsmeldung... konnte das Item aufgenommen werden true, bei Fehlern wie z.B. volles Inventar false

pushGameObject

public boolean pushGameObject(GameObject item)

Parameters:

item - das Item das hinzugefügt werden soll

Returns:

true wenn das Item aufgenommen wurde, false sonst

See Also:

addGameObject(org.jzuul.engine.GameObject)

getGameObject

public GameObject getGameObject(String name)

Get a GameObject by name

Parameters:

name - Name des GameObjects das geholt werden soll

Returns:

Das korespondierende GameObject, null wenn es nicht existiert

gameObjectNamesIterator

public Iterator gameObjectNamesIterator()

Liefert Iterator über die Namen der Objekt in dem Inventars

Returns:

Iterator über die GameObject Namen

containsGameObject

public boolean containsGameObject(String name)

Fragt ob das Iventory das GameObject mit dem Namen name enthält

Parameters:

name - der Name des GameObject

Returns:

true falls das Inventar mindest ein GameObject mit dem Namen enthält, false otherwise

deleteGameObject

public boolean deleteGameObject(String name)

Löscht das Item mit dem Namen name

Parameters:

name - der Name des zu löschenden Objektes

Returns:

always true ?

popGameObject

public GameObject popGameObject(String name)

popItem gibt das GameObject mit dem Namen name zurück und entfernt dieses aus dem Inventar

Parameters:

name -

Returns:

GameObject on success and null on failure

toString

public String toString()

Gibt eine textuelle Beschreibung des Inventars zurück

Returns:

einen multiline String der den Inhalt des Inventars beschreibt

getCharacterObjects

public List getCharacterObjects()

Sucht alle Character im Inventar

Returns:

Eine Liste aller Character Objekte im Inventar

getGameObjects

public Iterator getGameObjects()

Gibt alle GameObjects im Inventar zurück

Returns:

Iterator über die GameObjects Objekte

toElement

public Element toElement()

Wandelt das Inventar in ein JDOM XML Element um.

Returns:

ein JDOM Element Objekt das den Inhalt des Inventars beschreibt

contains

public boolean contains(String[] objects)

Fragt nach ob das Inventar die GameObjects mit den gegebenen Namen enthält

Parameters:

objects - Die Namen der zu überprüfenden GameObjects

Returns:

true wenn das Inventar für jeden Namen mindestens ein Objekt enthält, false otherwise

getNumberOfObject

public int getNumberOfObject(String name)

Fragt nach der Anzahl der Objekte mit dem gegebenen Namen

Parameters:

name - ein Name eines GameObjects

Returns:

die Anzahl der GameObjects in dem Inventar mit diesem Namen

contains

public boolean contains(List objects)

Parameters:

objects - eine Liste von Objekten die überprüft werden sollen

Returns:

True wenn die Objekte in dem Invetar sind, false sonst

See Also:

contains(String[] objects)

copy

public Inventory copy()

Erstellt eine depp copy des aktuellen Inventars

Returns:

ein neues Inventar objekt mit dem gleichen Inhalt wie das aktuelle Inventar