Package games.stendhal.server.entity.item

Class CaptureTheFlagFlag

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

All Implemented Interfaces:

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

public class CaptureTheFlagFlag
extends Item

represents the flag in Capture the Flag games - when player holds flag in hand, outfit displays flag. when player drops flag, outfit reverts to previous.

Author:

sjtsp2008

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
CaptureTheFlagFlag()	default constructor.
CaptureTheFlagFlag(String name, String clazz, String subclass, Map<String,String> attributes)

Method Summary

Modifier and Type	Method	Description
String	getColorValue()
int	getDetailValue()	return the detail id for flag
boolean	isDroppable()
boolean	onEquipped(RPEntity equipper, String slot)	if flag is held, update player's outfit.
boolean	onUnequipped()	item is being removed from owner - remove flag from players outfit this is called in the process of removing item from original owner, perhaps just before giving it to a new owner (or maybe just dropping it).

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, getQuantity, getRangedAttack, getState, getStatusAttackers, getSusceptibility, getTitle, getWeaponType, initializeActiveSlotsList, initializeStatusResistancesList, isBound, isFromCorpse, isOfClass, isPersistent, isUndroppableOnDeath, onPickedUp, onPutOnGround, onPutOnGround, onRemoveFromGround, onTurnReached, onUsed, 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

CaptureTheFlagFlag

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

CaptureTheFlagFlag

public CaptureTheFlagFlag()

default constructor. maybe just for test harness, maybe for simpler xml

Method Details

getColorValue

public String getColorValue()

getDetailValue

public int getDetailValue()

return the detail id for flag

Returns:

detail id

isDroppable

public boolean isDroppable()

onEquipped

public boolean onEquipped(RPEntity equipper,
 String slot)

if flag is held, update player's outfit. XXX current api returns boolean, but that has little value

Overrides:

onEquipped in class Item

Parameters:

equipper - entity equipping the item

slot - slot where the item is equipped

Returns:

unknown, see the note above

onUnequipped

public boolean onUnequipped()

item is being removed from owner - remove flag from players outfit this is called in the process of removing item from original owner, perhaps just before giving it to a new owner (or maybe just dropping it). at this point, the item still "belongs" to the original owner.

Overrides:

onUnequipped in class Item

Returns:

needs documenting