com.planet_ink.coffee_mud.Items.Basic
Class StdContainer

java.lang.Object
  com.planet_ink.coffee_mud.Items.Basic.StdItem
      com.planet_ink.coffee_mud.Items.Basic.StdContainer

All Implemented Interfaces:

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

Direct Known Subclasses:

CloseableContainer, GenContainer, LargeSack, LockableContainer, SmallSack, StdArmor, StdCage, StdClanContainer, StdDrink, StdElecContainer, StdHandOfCards, StdPortal, StdRideable, StdSmokable

public class StdContainer
extends StdItem
implements Container

Field Summary

protected int	capacity
protected long	containType
protected boolean	hasALid
protected boolean	hasALock
protected boolean	isLocked
protected boolean	isOpen

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

CONTAIN_ANYTHING, CONTAIN_BODIES, CONTAIN_CAGED, CONTAIN_CLOTHES, CONTAIN_COINS, CONTAIN_DAGGERS, CONTAIN_DESCS, CONTAIN_DRINKABLES, CONTAIN_FOOTWEAR, CONTAIN_KEYS, CONTAIN_LIQUID, CONTAIN_ONEHANDWEAPONS, CONTAIN_OTHERWEAPONS, CONTAIN_READABLES, CONTAIN_SCROLLS, CONTAIN_SMOKEABLES, CONTAIN_SSCOMPONENTS, CONTAIN_SWORDS

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

StdContainer()

Method Summary

boolean	canContain(Environmental E)
int	capacity()
long	containTypes()
void	emptyPlease()
void	executeMsg(Environmental myHost, CMMsg msg) The general message event handler for the object.
java.util.Vector	getContents()
boolean	hasALid()
boolean	hasALock()
java.lang.String	ID() The CoffeeMud Java Class ID shared by all instances of this object.
boolean	isLocked()
boolean	isOpen()
java.lang.String	keyName() For containers with lids and locks, this returns the unique string representing the key code required to unlock/lock the lid.
boolean	okMessage(Environmental myHost, CMMsg msg) The general message event previewer for the object.
protected void	reallyGetContents(Item container, Environmental own, java.util.Vector V)
void	setCapacity(int newValue)
void	setContainTypes(long containTypes)
void	setKeyName(java.lang.String newKeyName) For containers with lids and locks, this sets the unique string representing the key code required to unlock/lock the lid.
void	setLidsNLocks(boolean newHasALid, boolean newIsOpen, boolean newHasALock, boolean newIsLocked)
void	setMiscText(java.lang.String newMiscText) For objects which have false for their isGeneric method, this is used to set any internally coded strings to change the nature or behavior of the object.
boolean	tick(Tickable ticking, int tickID) this is the method which is called periodically by the threading engine.

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

abilityImbuesMagic, 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, displayText, envStats, expirationDate, fetchBehavior, fetchBehavior, fetchEffect, fetchEffect, fetchScript, finalize, fitsOn, getCodeNum, getSaveStatIndex, getStat, getStatCodes, getTickStatus, image, initializeClass, isGeneric, isStat, material, maxRange, minRange, miscTextFormat, name, Name, newInstance, numBehaviors, numberOfItems, numEffects, numScripts, owner, rawImage, rawLogicalAnd, rawProperLocationBitmap, rawSecretIdentity, rawWornCode, readableText, recoverEnvStats, recursiveWeight, removeFromOwnerContainer, riding, sameAs, savable, secretIdentity, setBaseEnvStats, setBaseValue, setContainer, setDatabaseID, setDescription, setDisplayText, setExpirationDate, setImage, setMaterial, setName, setOwner, setRawLogicalAnd, setRawProperLocationBitmap, setRawWornCode, setReadableText, setRiding, setSecretIdentity, setStat, setUsesRemaining, stopTicking, subjectToWearAndTear, tackOns, text, 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, readableText, recursiveWeight, removeFromOwnerContainer, secretIdentity, setBaseValue, setContainer, setDatabaseID, setMaterial, setOwner, setRawLogicalAnd, setRawProperLocationBitmap, setRawWornCode, setReadableText, 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

isLocked

protected boolean isLocked

hasALock

protected boolean hasALock

isOpen

protected boolean isOpen

hasALid

protected boolean hasALid

capacity

protected int capacity

containType

protected long containType

Constructor Detail

StdContainer

public StdContainer()

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 StdItem

Returns:

the name of this class

capacity

public int capacity()

Specified by:

capacity in interface Container

setCapacity

public void setCapacity(int newValue)

Specified by:

setCapacity in interface Container

okMessage

public boolean okMessage(Environmental myHost,
                         CMMsg msg)

Description copied from interface: MsgListener

The general message event previewer for the object. Messages passed herein are in a pending state, and may be safely modified or rejected without fear that they might be in the middle of being executed. Messages passed herein may not necessarily be FOR or FROM this object, but will almost always represent events which want to happen in the same rom. This method should always always return true UNLESS this message needs to be canceled, in which case it is necessary to tell the mob initiating the event (CMMsg.source()) why it is being cancelled. Every game event goes through these methods.

Specified by:

okMessage in interface MsgListener

Overrides:

okMessage in class StdItem

Parameters:

myHost - either the initiator of the event, or the host of this object

msg - the CMMsg that wants to be executed

Returns:

whether this message is allowed to execute

See Also:

CMMsg, CMMsg.source()

tick

public boolean tick(Tickable ticking,
                    int tickID)

Description copied from interface: Tickable

this is the method which is called periodically by the threading engine. How often it is called depends on the parameters passed to the threadding engine when it is submitted for thread access. Typically the period is once per TIME_TICK period, but that is determined when the object is submitted to the thread engine.

Specified by:

tick in interface Tickable

Overrides:

tick in class StdItem

Parameters:

ticking - a reference to this Tickable object

tickID - the TICKID_ constant describing this periodic call, as defined in Tickable

Returns:

true always, unless this object no longer wishes to ever tick again, in which case false

See Also:

Tickable, ServiceEngine, TickableGroup

executeMsg

public void executeMsg(Environmental myHost,
                       CMMsg msg)

Description copied from interface: MsgListener

The general message event handler for the object. Messages passed herein may not necessarily be FOR this object, or from it, but will almost always represent events happening in the same room. The messages have already been through an approval process, so this method is called only to affect the final execution of the meaning of the message. Every game event goes through these methods.

Specified by:

executeMsg in interface MsgListener

Overrides:

executeMsg in class StdItem

Parameters:

myHost - either the initiator of the event, or the host of this object

msg - the CMMsg that needs to be executed

See Also:

CMMsg

containTypes

public long containTypes()

Specified by:

containTypes in interface Container

setContainTypes

public void setContainTypes(long containTypes)

Specified by:

setContainTypes in interface Container

canContain

public boolean canContain(Environmental E)

Specified by:

canContain in interface Container

isLocked

public boolean isLocked()

Specified by:

isLocked in interface Container

hasALock

public boolean hasALock()

Specified by:

hasALock in interface Container

isOpen

public boolean isOpen()

Specified by:

isOpen in interface Container

hasALid

public boolean hasALid()

Specified by:

hasALid in interface Container

setLidsNLocks

public void setLidsNLocks(boolean newHasALid,
                          boolean newIsOpen,
                          boolean newHasALock,
                          boolean newIsLocked)

Specified by:

setLidsNLocks in interface Container

setMiscText

public void setMiscText(java.lang.String newMiscText)

Description copied from interface: Environmental

For objects which have false for their isGeneric method, this is used to set any internally coded strings to change the nature or behavior of the object. For objects which have true for their isGeneric method, this is used to set and parse the XML which will be used to fill out the fields in this object. Since Ability objects are never Generic, this will always be where parameters are read from an Ability instance.

Specified by:

setMiscText in interface Environmental

Overrides:

setMiscText in class StdItem

Parameters:

newMiscText - either an open internal text string, or XML

keyName

public java.lang.String keyName()

Description copied from interface: Container

For containers with lids and locks, this returns the unique string representing the key code required to unlock/lock the lid.

Specified by:

keyName in interface Container

Returns:

the key code

See Also:

Container.setKeyName(String)

setKeyName

public void setKeyName(java.lang.String newKeyName)

Description copied from interface: Container

For containers with lids and locks, this sets the unique string representing the key code required to unlock/lock the lid.

Specified by:

setKeyName in interface Container

Parameters:

newKeyName - the new key code

See Also:

Container.keyName()

emptyPlease

public void emptyPlease()

Specified by:

emptyPlease in interface Container

reallyGetContents

protected void reallyGetContents(Item container,
                                 Environmental own,
                                 java.util.Vector V)

getContents

public java.util.Vector getContents()

Specified by:

getContents in interface Container