Affectable, Behavable, CloseableLockable, CMObject, Contingent, DBIdentifiable, Environmental, Expireable, Modifiable, MsgListener, Physical, PhysicalAgent, Readable, Rider, StatsAffecting, Tickable, Container, Item, Wearable, java.lang.Cloneable, java.lang.Comparable<CMObject>CloseableContainer, GenContainer, LargeSack, LockableContainer, SmallSack, StdArmor, StdCage, StdClanContainer, StdDrink, StdElecContainer, StdHandOfCards, StdPortal, StdRideable, StdSmokablepublic class StdContainer extends StdItem implements Container
Wearable.CODES| Modifier and Type | Field | Description |
|---|---|---|
protected int |
capacity |
|
protected long |
containType |
|
protected boolean |
defaultsClosed |
|
protected boolean |
defaultsLocked |
|
protected boolean |
hasALid |
|
protected boolean |
hasALock |
|
protected boolean |
isLocked |
|
protected boolean |
isOpen |
|
protected int |
openDelayTicks |
idConverterCONTAIN_ANYTHING, CONTAIN_BODIES, CONTAIN_CAGED, CONTAIN_CLOTHES, CONTAIN_COINS, CONTAIN_DAGGERS, CONTAIN_DESCS, CONTAIN_DRINKABLES, CONTAIN_EATABLES, CONTAIN_FOOTWEAR, CONTAIN_KEYS, CONTAIN_LIQUID, CONTAIN_ONEHANDWEAPONS, CONTAIN_OTHERWEAPONS, CONTAIN_RAWMATERIALS, CONTAIN_READABLES, CONTAIN_SCROLLS, CONTAIN_SHIELDS, CONTAIN_SMOKEABLES, CONTAIN_SSCOMPONENTS, CONTAIN_SWORDS_name, affectPhyStats, affects, baseGoldValue, basePhyStats, behaviors, cachedImageName, CODES, databaseID, description, destroyed, displayText, dispossessionTime, material, me, miscText, myContainer, myUses, myWornCode, owner, phyStats, properWornBitmap, rawImageName, riding, scripts, secretIdentity, tickCtr, tickStatus, wornLogicalAnd, xtraValuesSTATUS_AFFECT, STATUS_ALIVE, STATUS_BEHAVIOR, STATUS_CLASS, STATUS_DEAD, STATUS_END, STATUS_FIGHT, STATUS_MISC, STATUS_MISC2, STATUS_MISC3, STATUS_MISC4, STATUS_MISC5, STATUS_MISC6, STATUS_MISC7, STATUS_NOT, STATUS_OTHER, STATUS_RACE, STATUS_REBIRTH, STATUS_SCRIPT, STATUS_START, STATUS_WEATHER, TICKID_AREA, TICKID_BALLISTICK, TICKID_CLAN, TICKID_CLANITEM, TICKID_DEADBODY_DECAY, TICKID_ELECTRONICS, TICKID_EMAIL, TICKID_EVENT, TICKID_EXIT_BEHAVIOR, TICKID_EXIT_REOPEN, TICKID_ITEM_BEHAVIOR, TICKID_ITEM_BOUNCEBACK, TICKID_LIGHT_FLICKERS, TICKID_LIVEAUCTION, TICKID_LONGERMASK, TICKID_MISCELLANEOUS, TICKID_MOB, TICKID_PROPERTY_SPECIAL, TICKID_QUEST, TICKID_READYTOSTOP, TICKID_ROOM_BEHAVIOR, TICKID_ROOM_ITEM_REJUV, TICKID_SHORTERMASK, TICKID_SOLITARYMASK, TICKID_SPECIALCOMBAT, TICKID_SPECIALMANEUVER, TICKID_SPELL_AFFECT, TICKID_SUPPORT, TICKID_TIMEAUCTION, TICKID_TRAP_DESTRUCTION, TICKID_TRAP_RESETDEFAULT_WORN_CODES, DEFAULT_WORN_DEPENDENCYGRID, DEFAULT_WORN_DESCS, DEFAULT_WORN_ORDER, DEFAULT_WORN_USUAL_NAMES, DEFAULT_WORN_WEIGHT_POINTS, DEFAULT_WORN_WEIGHTS, FILTER_ANY, FILTER_MOBINVONLY, FILTER_ROOMONLY, FILTER_UNWORNONLY, FILTER_WORNONLY, HIGHEST_WORN_CODE, IN_INVENTORY, WORN_ABOUT_BODY, WORN_ARMS, WORN_BACK, 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_RIGHT_FINGER, WORN_RIGHT_WRIST, WORN_TORSO, WORN_WAIST, WORN_WIELD| Constructor | Description |
|---|---|
StdContainer() |
| Modifier and Type | Method | Description |
|---|---|---|
boolean |
canContain(Item I) |
Returns whether this container is allowed to contain the given object.
|
int |
capacity() |
Returns the maximum weight that can fit inside this container.
|
long |
containTypes() |
Returns a bitmap of the types of things that this container can hold.
|
boolean |
defaultsClosed() |
For exits with a door, this returns whether this
defaults in a closed state.
|
boolean |
defaultsLocked() |
For exits with a door and lock, this returns whether this
defaults in a closed and locked state.
|
void |
emptyPlease(boolean flatten) |
Empties this container into its owner.
|
void |
executeMsg(Environmental myHost,
CMMsg msg) |
The general message event handler for the object.
|
java.lang.String |
genericName() |
Returns a generic name for this object, devoid of its particular
identifying details.
|
ReadOnlyList<Item> |
getContents() |
Returns all the immediate items in this container, including
other containers, but not the contents of those innner containers.
|
ReadOnlyList<Item> |
getDeepContents() |
Returns all the items in this container, including other
containers and THEIR contents, recursively.
|
boolean |
hasADoor() |
Returns whether this has a door, and must be opened before
being used.
|
boolean |
hasALock() |
Returns whether this has a lock on it, and, if locked,
must be unlocked before being used.
|
boolean |
hasContent() |
Returns whether there is anything at all in this container.
|
java.lang.String |
ID() |
The CoffeeMud Java Class ID shared by all instances of
this object.
|
boolean |
isInside(Item I) |
Returns whether the given item is, in fact, inside this container, even
recursively.
|
boolean |
isLocked() |
Returns whether this is LOCKED, and must be unlocked before
being used.
|
boolean |
isOpen() |
Returns whether this is OPEN and may be accessed or travelled through
|
java.lang.String |
keyName() |
For things with doors and locks, this returns the unique string
representing the key code required to unlock/lock it.
|
int |
numberOfItems() |
How many items this Item object represents.
|
boolean |
okMessage(Environmental myHost,
CMMsg msg) |
The general message event previewer for the object.
|
int |
openDelayTicks() |
Returns the number of ticks that this remains open when a mob
or player changes it from a closed to an open state, and this thing
defaults in a closed state.
|
int |
recursiveWeight() |
For a normal item, this method returns the same as phyStats().weight().
|
void |
setCapacity(int newValue) |
Sets the maximum weight that can fit inside this container.
|
void |
setContainTypes(long containTypes) |
Sets a bitmap of the types of things that this container can hold.
|
void |
setDoorsNLocks(boolean newHasALid,
boolean newIsOpen,
boolean newDefaultsClosed,
boolean newHasALock,
boolean newIsLocked,
boolean newDefaultsLocked) |
Modifies the various door/lock settings for this thing.
|
void |
setKeyName(java.lang.String newKeyName) |
For things with doors and locks, this sets the unique string
representing the key code required to unlock/lock it.
|
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.
|
void |
setOpenDelayTicks(int ticksToReset) |
Sets the number of ticks that this will remain open when a mob
or player changes it from a closed to an open state, and this thing
defaults in a closed state.
|
boolean |
tick(Tickable ticking,
int tickID) |
this is the method which is called periodically by the threading engine.
|
addEffect, addNonUninvokableEffect, basePhyStats, delAllEffects, delEffect, eachEffect, effects, fetchEffect, fetchEffect, numEffects, phyStats, recoverPhyStats, setBasePhyStatsaddBehavior, addScript, behaviors, delAllBehaviors, delAllScripts, delBehavior, delScript, eachBehavior, eachScript, fetchBehavior, fetchBehavior, fetchScript, numBehaviors, numScripts, scriptscopyOf, initializeClass, newInstanceamDestroyed, destroy, isSavable, setSavablecanSaveDatabaseID, databaseID, setDatabaseIDdescription, displayText, image, isGeneric, L, maxRange, minRange, miscTextFormat, Name, rawImage, sameAs, setDescription, setDisplayText, setImage, setName, textexpirationDate, setExpirationDatebaseGoldValue, container, material, owner, rawSecretIdentity, removeFromOwnerContainer, secretIdentity, setBaseValue, setContainer, setMaterial, setOwner, setSecretIdentity, setUsesRemaining, stopTicking, subjectToWearAndTear, ultimateContainer, usesRemaining, valuegetSaveStatIndex, getStat, getStatCodes, isStat, setStatclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitdescription, displayText, nameisReadable, readableText, setReadable, setReadableTextaffectCharState, affectCharStats, affectPhyStatsabilityImbuesMagic, addBehavior, addEffect, addNonUninvokableEffect, addScript, affectCharState, affectCharStats, affectPhyStats, alreadyWornMsg, amBeingWornProperly, amDestroyed, amWearingAt, baseGoldValue, basePhyStats, behaviors, canSaveDatabaseID, canWear, canWearComplete, cloneFix, compareProperLocations, compareTo, container, copyOf, databaseID, delAllBehaviors, delAllEffects, delAllScripts, delBehavior, delEffect, delScript, description, description, destroy, displayText, displayText, eachBehavior, eachEffect, eachScript, effects, expirationDate, fetchBehavior, fetchBehavior, fetchEffect, fetchEffect, fetchScript, fitsOn, getSaveStatIndex, getStat, getStatCodes, getTickStatus, I, image, initializeClass, isGeneric, isReadable, isSavable, isStat, L, material, maxRange, minRange, miscTextFormat, name, name, Name, newInstance, numBehaviors, numEffects, numScripts, owner, phyStats, rawImage, rawLogicalAnd, rawProperLocationBitmap, rawSecretIdentity, rawWornCode, readableText, recoverPhyStats, removeFromOwnerContainer, riding, sameAs, scripts, secretIdentity, setBasePhyStats, setBaseValue, setContainer, setDatabaseID, setDescription, setDisplayText, setExpirationDate, setImage, setMaterial, setName, setOwner, setRawLogicalAnd, setRawProperLocationBitmap, setRawWornCode, setReadable, setReadableText, setRiding, setSavable, setSecretIdentity, setStat, setUsesRemaining, stopTicking, subjectToWearAndTear, tackOns, text, ultimateContainer, unWear, usesRemaining, value, wearAt, wearEvenIfImpossible, wearIfPossible, wearIfPossible, whereCantWeargetTickStatus, nameamBeingWornProperly, amWearingAt, canWear, compareProperLocations, fitsOn, rawLogicalAnd, rawProperLocationBitmap, rawWornCode, setRawLogicalAnd, setRawProperLocationBitmap, setRawWornCode, unWear, wearAt, wearEvenIfImpossible, wearIfPossible, wearIfPossible, whereCantWearprotected boolean isLocked
protected boolean hasALock
protected boolean isOpen
protected boolean hasALid
protected boolean defaultsClosed
protected boolean defaultsLocked
protected int capacity
protected long containType
protected int openDelayTicks
public java.lang.String ID()
CMObjectpublic java.lang.String genericName()
PhysicalgenericName in interface PhysicalgenericName in class StdItempublic int capacity()
Containercapacity in interface ContainerContainer.setCapacity(int)public void setCapacity(int newValue)
ContainersetCapacity in interface ContainernewValue - the maximum weight that can fit inside this containerContainer.capacity()public int openDelayTicks()
CloseableLockableopenDelayTicks in interface CloseableLockableCloseableLockable.setOpenDelayTicks(int),
Tickable.TICKID_EXIT_REOPENpublic void setOpenDelayTicks(int ticksToReset)
CloseableLockablesetOpenDelayTicks in interface CloseableLockableticksToReset - the number of ticks this will remain openCloseableLockable.openDelayTicks(),
Tickable.TICKID_EXIT_REOPENpublic boolean okMessage(Environmental myHost, CMMsg msg)
MsgListenerokMessage in interface MsgListenerokMessage in class StdItemmyHost - either the initiator of the event, or the host of this objectmsg - the CMMsg that wants to be executedCMMsg,
CMMsg.source()public boolean tick(Tickable ticking, int tickID)
Tickabletick in interface Tickabletick in class StdItemticking - a reference to this Tickable objecttickID - the TICKID_ constant describing this periodic call, as defined in TickableTickable,
ServiceEngine,
TickableGrouppublic void executeMsg(Environmental myHost, CMMsg msg)
MsgListenerexecuteMsg in interface MsgListenerexecuteMsg in class StdItemmyHost - either the initiator of the event, or the host of this objectmsg - the CMMsg that needs to be executedCMMsgpublic long containTypes()
ContainercontainTypes in interface ContainerContainer.setContainTypes(long),
Container.CONTAIN_ANYTHING,
Container.CONTAIN_DESCSpublic void setContainTypes(long containTypes)
ContainersetContainTypes in interface ContainercontainTypes - a bitmap of the types of things that this container can hold.Container.containTypes(),
Container.CONTAIN_ANYTHING,
Container.CONTAIN_DESCSpublic boolean canContain(Item I)
ContainercanContain in interface ContainerI - the item to check against the allowed contentContainer.setContainTypes(long),
Container.containTypes()public boolean isLocked()
CloseableLockableisLocked in interface CloseableLockableCloseableLockable.hasADoor(),
CloseableLockable.hasALock()public boolean hasALock()
CloseableLockablehasALock in interface CloseableLockableCloseableLockable.isOpen(),
CloseableLockable.isLocked(),
CloseableLockable.hasADoor()public boolean isOpen()
CloseableLockableisOpen in interface CloseableLockablepublic boolean hasADoor()
CloseableLockablehasADoor in interface CloseableLockableCloseableLockable.isOpen(),
CloseableLockable.isLocked()public boolean defaultsClosed()
CloseableLockabledefaultsClosed in interface CloseableLockableCloseableLockable.hasADoor(),
CloseableLockable.defaultsLocked()public boolean defaultsLocked()
CloseableLockabledefaultsLocked in interface CloseableLockableCloseableLockable.hasADoor(),
CloseableLockable.defaultsClosed()public void setDoorsNLocks(boolean newHasALid,
boolean newIsOpen,
boolean newDefaultsClosed,
boolean newHasALock,
boolean newIsLocked,
boolean newDefaultsLocked)
CloseableLockablesetDoorsNLocks in interface CloseableLockablenewHasALid - whether this has a doornewIsOpen - whether this is open for usenewDefaultsClosed - whether this defaults closednewHasALock - whether this has a locknewIsLocked - whether this is presently lockednewDefaultsLocked - whether this defaults closed and locked.CloseableLockable.isOpen(),
CloseableLockable.isLocked(),
CloseableLockable.hasADoor(),
CloseableLockable.hasALock(),
CloseableLockable.defaultsClosed(),
CloseableLockable.defaultsLocked()public void setMiscText(java.lang.String newMiscText)
EnvironmentalsetMiscText in interface EnvironmentalsetMiscText in class StdItemnewMiscText - either an open internal text string, or XMLpublic java.lang.String keyName()
CloseableLockablekeyName in interface CloseableLockableCloseableLockable.setKeyName(String)public void setKeyName(java.lang.String newKeyName)
CloseableLockablesetKeyName in interface CloseableLockablenewKeyName - the new key codeCloseableLockable.keyName()public void emptyPlease(boolean flatten)
ContaineremptyPlease in interface Containerflatten - if true, will also remove all recursive items from their containerspublic boolean isInside(Item I)
Containerpublic int numberOfItems()
ItemnumberOfItems in interface ItemnumberOfItems in class StdItempublic int recursiveWeight()
ItemrecursiveWeight in interface ItemrecursiveWeight in class StdItemContainerpublic ReadOnlyList<Item> getDeepContents()
ContainergetDeepContents in interface ContainerContainer.getContents()public ReadOnlyList<Item> getContents()
ContainergetContents in interface ContainerContainer.getDeepContents()public boolean hasContent()
ContainerhasContent in interface Container