Package games.stendhal.server.entity.item

Class ConsumableItem

java.lang.Object

marauroa.common.game.Attributes

marauroa.common.game.SlotOwner

marauroa.common.game.RPObject

games.stendhal.server.entity.Entity

games.stendhal.server.entity.PassiveEntity

games.stendhal.server.entity.item.Item

games.stendhal.server.entity.item.StackableItem

games.stendhal.server.entity.item.ConsumableItem

All Implemented Interfaces:

EquipListener, TurnListener, UseListener, Stackable<StackableItem>, Killer, Cloneable, Comparable<ConsumableItem>, Iterable<String>, Serializable

Direct Known Subclasses:

Drink, Food, StatusHealer

public class ConsumableItem
extends StackableItem
implements Comparable<ConsumableItem>

Represents everything that can be consumed by RPentity. Including food, poison, antidote, ... Note: this class has a natural ordering that is inconsistent with equals.

Nested Class Summary

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

RPObject.ID

Field Summary

Fields

Modifier and Type	Field	Description
protected final Feeder	feeder

Fields inherited from class games.stendhal.server.entity.item.Item

DEGRADATION_TIMEOUT

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
ConsumableItem(ConsumableItem item)	copy constructor.
ConsumableItem(String name, String clazz, String subclass, Map<String,String> attributes)

Method Summary

Modifier and Type	Method	Description
int	compareTo(ConsumableItem other)
int	consume()	Consumes a part of this item.
boolean	consumed()	Checks whether this item has already been fully consumed.
int	getAmount()
int	getFrecuency()
Set<StatusType>	getImmunizations()
int	getRegen()
boolean	onUsed(RPEntity user)	Verifies item is near to player.
void	put(String attribute, double value)	This method set the value of an attribute
void	put(String attribute, int value)	This method set the value of an attribute
void	put(String attribute, String value)	This method set the value of an attribute

Methods inherited from class games.stendhal.server.entity.item.StackableItem

add, getCapacity, getQuantity, isStackable, removeOne, setCapacity, setQuantity, splitOff, sub, update

Methods inherited from class games.stendhal.server.entity.item.Item

addStatusAttacker, autobind, canBeEquippedIn, describe, deteriorate, deteriorate, generateRPClass, getAttack, getAttackRate, getAttackRate, getBoundTo, getDamageType, getDefaultAttackRate, getDefense, getDescriptionName, getDeterioration, getItemClass, getItemData, getItemSubclass, getMinLevel, getName, getPlantGrower, getPossibleSlots, getRangedAttack, getState, getStatusAttackers, getSusceptibility, getTitle, getWeaponType, initializeActiveSlotsList, initializeStatusResistancesList, isBound, isFromCorpse, isOfClass, isPersistent, isUndroppableOnDeath, onEquipped, onPickedUp, onPutOnGround, onPutOnGround, onRemoveFromGround, onTurnReached, onUnequipped, removeFromWorld, repair, setBoundTo, setDamageType, setEquipableSlots, setFromCorpse, setItemData, setPersistent, setPlantGrower, setState, setSusceptibilities, setUndroppableOnDeath, setUseBehavior, toString

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

getAdjacentNodes, getArea, getArea, getCursor, getDescription, getEntitySlot, getHeight, getOrigin, getResistance, getResistance, 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, size, slots, slotsIterator, store, 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, 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

Field Details

feeder

protected final Feeder feeder

Constructor Details

ConsumableItem

public ConsumableItem(String name,
 String clazz,
 String subclass,
 Map<String,String> attributes)

ConsumableItem

public ConsumableItem(ConsumableItem item)

copy constructor.

Parameters:

item - item to copy

Method Details

put

public void put(String attribute,
 double value)

Description copied from class: Attributes

This method set the value of an attribute

Overrides:

put in class Attributes

Parameters:

attribute - the attribute to be set.

value - the value we want to set.

put

public void put(String attribute,
 int value)

Description copied from class: Attributes

This method set the value of an attribute

Overrides:

put in class Attributes

Parameters:

attribute - the attribute to be set.

value - the value we want to set.

put

public void put(String attribute,
 String value)

Description copied from class: Attributes

This method set the value of an attribute

Overrides:

put in class Attributes

Parameters:

attribute - the attribute to be set.

value - the value we want to set.

getAmount

public int getAmount()

getFrecuency

public int getFrecuency()

getRegen

public int getRegen()

consume

public int consume()

Consumes a part of this item.

Returns:

The amount that has been consumed

consumed

public boolean consumed()

Checks whether this item has already been fully consumed.

Returns:

true iff this item has been consumed

onUsed

public boolean onUsed(RPEntity user)

Verifies item is near to player. if so splits one single item of and calls consumeItem of the player.

Specified by:

onUsed in interface UseListener

Overrides:

onUsed in class Item

Parameters:

user - the eating player

Returns:

true if consumption can be started

compareTo

public int compareTo(ConsumableItem other)

Specified by:

compareTo in interface Comparable<ConsumableItem>

getImmunizations

public Set<StatusType> getImmunizations()