Package games.stendhal.server.entity.mapstuff.chest

Class Chest

java.lang.Object

marauroa.common.game.Attributes

marauroa.common.game.SlotOwner

marauroa.common.game.RPObject

games.stendhal.server.entity.Entity

games.stendhal.server.entity.mapstuff.chest.Chest

All Implemented Interfaces:

UseListener, Killer, Cloneable, Iterable<String>, Serializable

Direct Known Subclasses:

NPCOwnedChest, PersonalChest, StoredChest

public class Chest
extends Entity
implements UseListener

A chest is an unmovable container. It can be opened and closed. While it is open, every player can put items in and take them out later. A player can take out items that another player put in.

Nested Class Summary

Nested classes/interfaces inherited from class marauroa.common.game.RPObject

RPObject.ID

Field Summary

Fields inherited from class games.stendhal.server.entity.Entity

area

Fields inherited from class marauroa.common.game.RPObject

INVALID_ID

Fields inherited from class marauroa.common.game.SlotOwner

slots

Constructor Summary

Constructors

Constructor	Description
Chest()	Creates a new chest.
Chest(RPObject object)	Creates a new chest.

Method Summary

Modifier and Type	Method	Description
void	add(PassiveEntity entity)	Adds a passive entity (like an item) to the chest.
void	close()	Close the chest.
String	describe()	Describes the entity (if a players looks at it).
static void	generateRPClass()
Iterator<RPObject>	getContent()	Returns the content.
String	getDescriptionName(boolean definite)	Returns the name or something that can be used to identify the entity for the player.
boolean	isOpen()	Determine if the chest is open.
boolean	onUsed(RPEntity user)	Invoked when the object is used.
void	open()	Open the chest.
int	size()	Returns the number of attributes and events this object is made of.
void	update()

Methods inherited from class games.stendhal.server.entity.Entity

getAdjacentNodes, getArea, getArea, getCursor, getDescription, getEntitySlot, getHeight, getName, getOrigin, getResistance, getResistance, getTitle, getWidth, getX, getY, getZone, hasDescription, isInSight, isObstacle, nextTo, nextTo, notifyWorldAboutChanges, onAdded, onMoved, onRemoved, setCursor, setDescription, setEntityClass, setEntitySubclass, setMenu, setPosition, setResistance, setSize, setVisibility, slotIterator, slots, squaredDistance, squaredDistance, stopped

Methods inherited from class marauroa.common.game.RPObject

addEvent, addLink, addLink, addMap, addSlot, addSlot, applyDifferences, clearEvents, clearVisible, clone, containsKey, equals, events, eventsIterator, fill, get, getBaseContainer, getBoolean, getContainer, getContainerBaseOwner, getContainerOwner, getContainerSlot, getDifferences, getDouble, getFromSlots, getID, getInt, getLink, getLinkedObject, getMap, getSlot, has, hashCode, hasLink, hasMap, hasSlot, hide, isContained, isEmpty, isHidden, isStorable, maps, put, put, put, put, readObject, remove, removeLink, removeMap, removeSlot, resetAddedAndDeleted, resetAddedAndDeletedMaps, resetAddedAndDeletedRPLink, resetAddedAndDeletedRPSlot, setAddedMaps, setAddedRPSlot, setContainer, setDeletedMaps, setDeletedRPSlot, setID, slots, slotsIterator, store, toString, unhide, unstore, writeObject, writeObject, writeToJson

Methods inherited from class marauroa.common.game.SlotOwner

deserializeRPSlots, fill, serializeRPSlots

Methods inherited from class marauroa.common.game.Attributes

add, applyDifferences, get, getBool, getDouble, getInt, getList, getLong, getRPClass, has, instanceOf, iterator, put, put, put, put, put, readFromMap, remove, resetAddedAndDeletedAttributes, setAddedAttributes, setDeletedAttributes, setRPClass, setRPClass, toAttributeString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from interface games.stendhal.server.entity.Killer

clone

Constructor Details

Chest

public Chest()

Creates a new chest.

Chest

public Chest(RPObject object)

Creates a new chest.

Parameters:

object - RPObject

Method Details

generateRPClass

public static void generateRPClass()

getDescriptionName

public String getDescriptionName(boolean definite)

Description copied from class: Entity

Returns the name or something that can be used to identify the entity for the player.

Overrides:

getDescriptionName in class Entity

Parameters:

definite - true for "the" and false for "a/an" in case the entity has no name

Returns:

name

update

public void update()

Overrides:

update in class Entity

open

public void open()

Open the chest.

close

public void close()

Close the chest.

isOpen

public boolean isOpen()

Determine if the chest is open.

Returns:

true if the chest is open.

add

public void add(PassiveEntity entity)

Adds a passive entity (like an item) to the chest.

Parameters:

entity - entity to add

size

public int size()

Description copied from class: RPObject

Returns the number of attributes and events this object is made of.

Overrides:

size in class RPObject

Returns:

amount of attributes

getContent

public Iterator<RPObject> getContent()

Returns the content.

Returns:

iterator for the content

onUsed

public boolean onUsed(RPEntity user)

Description copied from interface: UseListener

Invoked when the object is used.

Specified by:

onUsed in interface UseListener

Parameters:

user - the RPEntity who uses the object

Returns:

true if successful

describe

public String describe()

Description copied from class: Entity

Describes the entity (if a players looks at it).

Overrides:

describe in class Entity

Returns:

description from the players point of view