com.planet_ink.coffee_mud.Items.Basic
Class GenPackagedItems

java.lang.Object
  com.planet_ink.coffee_mud.Items.Basic.StdItem
      com.planet_ink.coffee_mud.Items.Basic.GenItem
          com.planet_ink.coffee_mud.Items.Basic.GenPackagedItems

All Implemented Interfaces:

Behavable, CMModifiable, CMObject, Environmental, MsgListener, Rider, StatsAffecting, Tickable, Item, PackagedItems, java.lang.Cloneable, java.lang.Comparable<CMObject>

public class GenPackagedItems
extends GenItem
implements PackagedItems

Field Summary

protected byte[]

readableText

Fields inherited from class com.planet_ink.coffee_mud.Items.Basic.StdItem

affects, baseEnvStats, baseGoldValue, behaviors, CODES, databaseID, description, destroyed, displayText, dispossessionTime, envStats, imageName, material, miscText, myContainer, myUses, myWornCode, name, owner, properWornBitmap, riding, scripts, secretIdentity, tickStatus, wornLogicalAnd, xtraValues

Fields inherited from interface com.planet_ink.coffee_mud.Items.interfaces.Item

IN_INVENTORY, WORN_ABOUT_BODY, WORN_ARMS, WORN_BACK, WORN_CODES, WORN_DEPENDENCYGRID, WORN_DESCS, WORN_EARS, WORN_EYES, WORN_FEET, WORN_FLOATING_NEARBY, WORN_HANDS, WORN_HEAD, WORN_HELD, WORN_LEFT_FINGER, WORN_LEFT_WRIST, WORN_LEGS, WORN_MOUTH, WORN_NECK, WORN_ORDER, WORN_RIGHT_FINGER, WORN_RIGHT_WRIST, WORN_TORSO, WORN_WAIST, WORN_WEIGHT_POINTS, WORN_WEIGHTS, WORN_WIELD, WORNREQ_ANY, WORNREQ_UNWORNONLY, WORNREQ_WORNONLY

Constructor Summary

GenPackagedItems()

Method Summary

protected boolean	abilityImbuesMagic()
java.lang.String	displayText() Gets the raw string used to show what this object looks like in the room.
Item	getItem()
java.lang.String	ID() The CoffeeMud Java Class ID shared by all instances of this object.
boolean	isPackagable(java.util.Vector V)
java.lang.String	name() The displayable name of this object.
int	numberOfItemsInPackage()
boolean	packageMe(Item I, int number)
java.lang.String	packageText()
java.lang.String	readableText() If the IS_READABLE flag is set for the envStats().sensesMask() flag on this item, then this method will be consulted as representing any writing on the Item.
void	setNumberOfItemsInPackage(int number)
void	setPackageText(java.lang.String text)
void	setReadableText(java.lang.String text) Changes the text that is written on the item.
java.util.Vector	unPackage(int number)

Methods inherited from class com.planet_ink.coffee_mud.Items.Basic.GenItem

getStat, getStatCodes, isGeneric, sameAs, setMiscText, setStat, text

Methods inherited from class com.planet_ink.coffee_mud.Items.Basic.StdItem

addBehavior, addEffect, addNonUninvokableEffect, addScript, affectCharState, affectCharStats, affectEnvStats, alreadyWornMsg, amDestroyed, amWearingAt, baseEnvStats, baseGoldValue, canWear, canWearComplete, cloneEffects, cloneFix, compareProperLocations, compareTo, container, copyOf, databaseID, delBehavior, delEffect, delScript, description, destroy, envStats, executeMsg, expirationDate, fetchBehavior, fetchBehavior, fetchEffect, fetchEffect, fetchScript, finalize, fitsOn, getCodeNum, getSaveStatIndex, getTickStatus, image, initializeClass, isStat, material, maxRange, minRange, miscTextFormat, Name, newInstance, numBehaviors, numberOfItems, numEffects, numScripts, okMessage, owner, rawImage, rawLogicalAnd, rawProperLocationBitmap, rawSecretIdentity, rawWornCode, recoverEnvStats, recursiveWeight, removeFromOwnerContainer, riding, savable, secretIdentity, setBaseEnvStats, setBaseValue, setContainer, setDatabaseID, setDescription, setDisplayText, setExpirationDate, setImage, setMaterial, setName, setOwner, setRawLogicalAnd, setRawProperLocationBitmap, setRawWornCode, setRiding, setSecretIdentity, setUsesRemaining, stopTicking, subjectToWearAndTear, tackOns, tick, ultimateContainer, unWear, usesRemaining, value, wearAt, wearEvenIfImpossible, wearIfPossible, whereCantWear

Methods inherited from class java.lang.Object

clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.planet_ink.coffee_mud.Items.interfaces.Item

amWearingAt, baseGoldValue, canWear, compareProperLocations, container, databaseID, fitsOn, material, numberOfItems, owner, rawLogicalAnd, rawProperLocationBitmap, rawSecretIdentity, rawWornCode, recursiveWeight, removeFromOwnerContainer, secretIdentity, setBaseValue, setContainer, setDatabaseID, setMaterial, setOwner, setRawLogicalAnd, setRawProperLocationBitmap, setRawWornCode, setSecretIdentity, setUsesRemaining, stopTicking, subjectToWearAndTear, ultimateContainer, unWear, usesRemaining, value, wearAt, wearEvenIfImpossible, wearIfPossible, whereCantWear

Methods inherited from interface com.planet_ink.coffee_mud.core.interfaces.Rider

riding, setRiding

Field Detail

readableText

protected byte[] readableText

Constructor Detail

GenPackagedItems

public GenPackagedItems()

Method Detail

ID

public java.lang.String ID()

Description copied from interface: CMObject

The CoffeeMud Java Class ID shared by all instances of this object. Unlike the Java Class name, this method does not include package information. However, it must return a String value unique to its class category in the ClassLoader. Class categories include Libraries, Common, Areas, Abilities, Behaviors, CharClasses, Commands, Exits Locales, MOBS, Races, WebMacros, Basic Items, Armor, Weapons, ClanItems, MiscTech. The name is typically identical to the class name.

Specified by:

ID in interface CMObject

Overrides:

ID in class GenItem

Returns:

the name of this class

abilityImbuesMagic

protected boolean abilityImbuesMagic()

Overrides:

abilityImbuesMagic in class StdItem

name

public java.lang.String name()

Description copied from interface: Environmental

The displayable name of this object. May be modified by envStats() object. Is derived from the Name().

Specified by:

name in interface Environmental

Specified by:

name in interface Tickable

Overrides:

name in class StdItem

Returns:

the modified final name of this object on the map.

See Also:

Environmental.Name()

displayText

public java.lang.String displayText()

Description copied from interface: Environmental

Gets the raw string used to show what this object looks like in the room. May be used as a basis for other methods, such as the title of rooms, and what an exit looks like when open. The value for Items may be null if the item is not displayed when the room is seen.

Specified by:

displayText in interface Environmental

Overrides:

displayText in class StdItem

Returns:

the string describing how this object looks in the room

numberOfItemsInPackage

public int numberOfItemsInPackage()

Specified by:

numberOfItemsInPackage in interface PackagedItems

setNumberOfItemsInPackage

public void setNumberOfItemsInPackage(int number)

Specified by:

setNumberOfItemsInPackage in interface PackagedItems

readableText

public java.lang.String readableText()

Description copied from interface: Item

If the IS_READABLE flag is set for the envStats().sensesMask() flag on this item, then this method will be consulted as representing any writing on the Item. Typically accessed with the READ command. This flag is defined in the EnvStats interface

Specified by:

readableText in interface Item

Overrides:

readableText in class GenItem

Returns:

the readable text on the item.

See Also:

EnvStats

setReadableText

public void setReadableText(java.lang.String text)

Description copied from interface: Item

Changes the text that is written on the item. This method does NOT set the IS_READABLE flag on the envStats().sensesMask flag. This flag is defined in the EnvStats interface

Specified by:

setReadableText in interface Item

Overrides:

setReadableText in class GenItem

Parameters:

text - what is written on the item. Empty string means nothing.

See Also:

EnvStats

packageMe

public boolean packageMe(Item I,
                         int number)

Specified by:

packageMe in interface PackagedItems

isPackagable

public boolean isPackagable(java.util.Vector V)

Specified by:

isPackagable in interface PackagedItems

getItem

public Item getItem()

Specified by:

getItem in interface PackagedItems

unPackage

public java.util.Vector unPackage(int number)

Specified by:

unPackage in interface PackagedItems

packageText

public java.lang.String packageText()

Specified by:

packageText in interface PackagedItems

setPackageText

public void setPackageText(java.lang.String text)

Specified by:

setPackageText in interface PackagedItems