Package games.stendhal.server.entity.item

Class AreaUseItem

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.AreaUseItem

All Implemented Interfaces:

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

Direct Known Subclasses:

MetalDetector, Shovel

public class AreaUseItem
extends Item

Nested Class Summary

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

RPObject.ID

Field Summary

Fields

Modifier and Type	Field	Description
protected String	use_sound

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

Method Summary

Modifier and Type	Method	Description
boolean	onUsed(RPEntity user)	Invoked when the object is used.
protected boolean	onUsedInArea(RPEntity user)	Inheriting classes can override this to determine action to execute when item is used in correct area.
protected boolean	onUsedInArea(RPEntity user, StendhalRPZone zone, int x, int y)	Inheriting classes can override this to determine action to execute when item is used in correct area.

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

autobind, canBeEquippedIn, describe, deteriorate, deteriorate, generateRPClass, getAttack, getAttackRate, getAttackRate, getBoundTo, getDamageType, getDefaultAttackRate, getDefense, getDescriptionName, getDeterioration, getInfoString, getItemClass, getItemSubclass, getMinLevel, getName, getPlantGrower, getPossibleSlots, getQuantity, getRangedAttack, getSusceptibility, getTitle, getWeaponType, initializeActiveSlotsList, initializeStatusResistancesList, isBound, isFromCorpse, isOfClass, isPersistent, isUndroppableOnDeath, onEquipped, onPickedUp, onPutOnGround, onPutOnGround, onRemoveFromGround, onTurnReached, onUnequipped, removeFromWorld, removeOne, repair, setBoundTo, setDamageType, setEquipableSlots, setFromCorpse, setInfoString, setPersistent, setPlantGrower, 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, update

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, 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

Field Details

use_sound

protected String use_sound

Constructor Details

AreaUseItem

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

AreaUseItem

public AreaUseItem(AreaUseItem item)

Copy constructor.

Parameters:

item - Item to copy.

Method Details

onUsed

public boolean onUsed(RPEntity user)

Description copied from interface: UseListener

Invoked when the object is used.

Specified by:

onUsed in interface UseListener

Overrides:

onUsed in class Item

Parameters:

user - the RPEntity who uses the object

Returns:

true if successful

onUsedInArea

protected boolean onUsedInArea(RPEntity user,
 StendhalRPZone zone,
 int x,
 int y)

Inheriting classes can override this to determine action to execute when item is used in correct area.

Parameters:

user - Entity using the item.

zone - Zone the entity is currently in.

x - X coordinate of entity's position.

y - Y coordinate of entity's position.

Returns:

true if item used successfully.

onUsedInArea

protected boolean onUsedInArea(RPEntity user)

Inheriting classes can override this to determine action to execute when item is used in correct area.

Parameters:

user - Entity using the item.

Returns:

true if item used successfully.