Package games.stendhal.server.entity.item

Class OwnedItem

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

All Implemented Interfaces:

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

Direct Known Subclasses:

Bestiary

public abstract class OwnedItem
extends Item

Class representing an item owned by an entity.

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

Method Summary

Modifier and Type	Method	Description
boolean	canEquipToSlot(RPEntity entity, String slot)	Override to check if an entity can equip to slot.
String	describe()	Describes the entity (if a players looks at it).
abstract String	getOwner()	Override to retrieve owner name.
boolean	hasOwner()	Override to check if item has owner.
boolean	isOwner(String name)	Checks if the submitted name matches the owner of the item.
void	onEquipFail(RPEntity entity, String slot)	Override for action to take when an entity cannot equip to specified slot.
boolean	onUsed(RPEntity user)	Invoked when the object is used.
void	onUseFail(RPEntity user)
void	setBlacklistSlots(List<String> slots)	Sets the slots that this item cannot be equipped to if it has an owner.
abstract void	setOwner(String name)	Sets the owner of the item.
void	setOwnerOnlySlots(List<String> slots)	Sets the slots that can be equipped to by owner only if it has an owner.

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

addStatusAttacker, autobind, canBeEquippedIn, deteriorate, deteriorate, generateRPClass, getAttack, getAttackRate, getAttackRate, getBoundTo, getDamageType, getDefaultAttackRate, getDefense, getDescriptionName, getDeterioration, getItemClass, getItemData, getItemSubclass, getMinLevel, getName, getPlantGrower, getPossibleSlots, getQuantity, getRangedAttack, getState, getStatusAttackers, getSusceptibility, getTitle, getWeaponType, initializeActiveSlotsList, initializeStatusResistancesList, isBound, isFromCorpse, isOfClass, isPersistent, isUndroppableOnDeath, onEquipped, onPickedUp, onPutOnGround, onPutOnGround, onRemoveFromGround, onTurnReached, onUnequipped, removeFromWorld, removeOne, 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, 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

Constructor Details

OwnedItem

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

OwnedItem

public OwnedItem(OwnedItem item)

Method Details

describe

public String describe()

Description copied from class: Entity

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

Overrides:

describe in class Item

Returns:

description from the players point of view

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

setOwner

public abstract void setOwner(String name)

Sets the owner of the item.

Parameters:

name - Owner's name.

getOwner

public abstract String getOwner()

Override to retrieve owner name.

Returns:

Name of owner or null if not owned.

hasOwner

public boolean hasOwner()

Override to check if item has owner.

Returns:

true if owned.

isOwner

public boolean isOwner(String name)

Checks if the submitted name matches the owner of the item.

Parameters:

name - Name to check.

Returns:

true if the name matches the item owner.

canEquipToSlot

public boolean canEquipToSlot(RPEntity entity,
 String slot)

Override to check if an entity can equip to slot.

Parameters:

entity - Entity attempting to equip.

slot - Slot where item is being equipped.

Returns:

true if can be equipped, false otherwise.

onEquipFail

public void onEquipFail(RPEntity entity,
 String slot)

Override for action to take when an entity cannot equip to specified slot.

Parameters:

entity - Entity attempting to equip.

slot - Slot where item could not be equipped.

onUseFail

public void onUseFail(RPEntity user)

setBlacklistSlots

public void setBlacklistSlots(List<String> slots)

Sets the slots that this item cannot be equipped to if it has an owner.

Parameters:

slots - List of slot names.

setOwnerOnlySlots

public void setOwnerOnlySlots(List<String> slots)

Sets the slots that can be equipped to by owner only if it has an owner.

Parameters:

slots - List of slots names.