org.starhope.appius.game
Class NamedInventoryItem

java.lang.Object
  org.starhope.appius.sql.SQLPeerDatum
      org.starhope.appius.game.InventoryItem
          org.starhope.appius.game.NamedInventoryItem

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

Pet, Vehicle

public abstract class NamedInventoryItem
extends InventoryItem

TODO: The documentation for this type (NamedInventoryItem) is incomplete. (brpocock, Nov 24, 2009)

Author:

brpocock

See Also:

Serialized Form

Field Summary

protected double	health TODO: document this field (brpocock, Nov 24, 2009) itemHealth (NamedInventoryItem)
private String	nomen TODO: document this field (brpocock, Nov 24, 2009) nomen (NamedInventoryItem)
private static long	serialVersionUID TODO: document this field (brpocock, Nov 24, 2009) serialVersionUID (long)

Fields inherited from class org.starhope.appius.game.InventoryItem

active, CLOTHES, FURNITURE, GAME_EQUIP_ITEM, id, MUSIC, ownerID, PATTERNS, PIVITZ, slotNumber, STATIONERY, STRUCTURE, T_Backpacks, T_Ceiling, T_Ceiling_Furniture, T_Dresses, T_Ears, T_Eyes, T_Floor_Furniture, T_Flooring, T_Game_Equip_Item, T_Music, T_Neck, T_Orbitz, T_Pants, T_Pattern, T_Pet, T_Pivitz, T_Shirts, T_Stationery, T_TootBook_Avatar_BG, T_TootBook_Box_Style, T_TootBook_Icon, T_TootBook_Page_BG, T_TootBook_Title_BG, T_TootBookTheme, T_Tops, T_Vehicle, T_Wall_Furniture, T_Wallpaper, TB_AVATAR_BG, TB_BOX_STYLES, TB_ICON, TB_PAGE_BG, TB_TITLE_BG, type, Type_Backpacks, Type_Ceiling, Type_Ceiling_Furniture, Type_Dresses, Type_Ears, Type_Eyes, Type_Floor_Furniture, Type_Flooring, Type_Music, Type_Neck, Type_Orbitz, Type_Pants, Type_Pattern, Type_Pivitz, Type_Shirts, Type_Tops, Type_Wall_Furniture, Type_Wallpaper

Fields inherited from class org.starhope.appius.sql.SQLPeerDatum

hackyDatabaseConnection

Constructor Summary

NamedInventoryItem()

Method Summary

double	adjustItemHealth(double addend) TODO: document this method (brpocock, Nov 24, 2009)
double	adjustItemHealth(double addend, double factor) TODO: document this method (brpocock, Nov 24, 2009)
double	adjustItemHealthGeom(double factor) TODO: document this method (brpocock, Nov 24, 2009)
String	getDisplayName() This is the display name to be formatted onto an avatar.
abstract String	getDisplayPrefixForType() This is the prefix shown before objects of this type's display name
double	getItemHealth()
String	getMoniker() TODO: document this method (brpocock, Nov 24, 2009)
String	getNomen()
void	setItemHealth(double newHealth)
void	setNomen(String newNomen)

Methods inherited from class org.starhope.appius.game.InventoryItem

asClothing, asHomeDecorItem, assertValidType, assertValidTypeID, equals, equip, flush, getByID, getByID, getCacheUniqueID, getClassForThisType, getClassForType, getClassForType, getFromInventory, getID, getItemClass, getMountPoint, getOwner, getOwnerID, getSlotNumber, getType, getTypeID, getTypesOfClothingT, getTypesOfFurnitureT, getTypesOfHomeDecorT, getTypesOfStructureT, getTypesOfWearablesT, hasANomen, hashCode, identifiesAs, isActive, isAPet, isClothingOnly, isFurniture, isMusic, isPattern, isPet, isPivitz, isStructure, isVehicle, isWearable, pullFromInventory, setActive, setFromInventory, setOwner, setOwnerID, setSlotHarsh, setSlotNumber, setType, setTypeID, toJSON, toString, unequip

Methods inherited from class org.starhope.appius.sql.SQLPeerDatum

changed, findInCache, get, prepareX, prepareX, saveInCache, set, set

Methods inherited from class java.lang.Object

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

Field Detail

serialVersionUID

private static final long serialVersionUID

TODO: document this field (brpocock, Nov 24, 2009) serialVersionUID (long)

See Also:

Constant Field Values

health

protected double health

TODO: document this field (brpocock, Nov 24, 2009) itemHealth (NamedInventoryItem)

nomen

private String nomen

TODO: document this field (brpocock, Nov 24, 2009) nomen (NamedInventoryItem)

Constructor Detail

NamedInventoryItem

public NamedInventoryItem()

Method Detail

adjustItemHealth

public double adjustItemHealth(double addend)

TODO: document this method (brpocock, Nov 24, 2009)

Parameters:

addend - WRITEME

Returns:

WRITEME

adjustItemHealth

public double adjustItemHealth(double addend,
                               double factor)

TODO: document this method (brpocock, Nov 24, 2009)

Parameters:

addend - WRITEME

factor - WRITEME

Returns:

WRITEME

adjustItemHealthGeom

public double adjustItemHealthGeom(double factor)

TODO: document this method (brpocock, Nov 24, 2009)

Parameters:

factor - WRITEME

Returns:

WRITEME

getDisplayName

public String getDisplayName()

This is the display name to be formatted onto an avatar.

Returns:

WRITEME

getDisplayPrefixForType

public abstract String getDisplayPrefixForType()

This is the prefix shown before objects of this type's display name

Returns:

WRITEME

getItemHealth

public double getItemHealth()

Returns:

the itemHealth

getMoniker

public String getMoniker()

TODO: document this method (brpocock, Nov 24, 2009)

Returns:

The moniker uniquely identifying this object by owner, type, and nomen

getNomen

public String getNomen()

Returns:

the nomen

setItemHealth

public void setItemHealth(double newHealth)

Parameters:

newHealth - the itemHealth to set

setNomen

public void setNomen(String newNomen)
              throws AlreadyExistsException,
                     ForbiddenUserException

Parameters:

newNomen - the nomen to set

Throws:

AlreadyExistsException - If the name is already used by another item of this type owned by this user

ForbiddenUserException - If the name is forbidden by filters