Package com.planet_ink.coffee_mud.Items.Basic

Class StdContainerWrapper

java.lang.Object

com.planet_ink.coffee_mud.Items.Basic.StdItemWrapper

com.planet_ink.coffee_mud.Items.Basic.StdContainerWrapper

All Implemented Interfaces:

Affectable, Behavable, CloseableLockable, CMObject, CMObjectWrapper, Contingent, DBIdentifiable, Environmental, Expireable, Modifiable, MsgListener, Physical, PhysicalAgent, Readable, Rider, StatsAffecting, Tickable, Container, Item, Wearable, java.lang.Cloneable, java.lang.Comparable<CMObject>

Direct Known Subclasses:

StdRideableWrapper

public class StdContainerWrapper
extends StdItemWrapper
implements Item, Container, CMObjectWrapper

Nested Class Summary

Nested classes/interfaces inherited from interface com.planet_ink.coffee_mud.Items.interfaces.Wearable

Wearable.CODES

Field Summary

Fields

Modifier and Type	Field	Description
protected Container	container

Fields inherited from interface com.planet_ink.coffee_mud.core.interfaces.CMObject

idConverter

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_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

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

amDestroyed, basePhyStats, isSavable, item, myContainer, owner, riding

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

DEFAULT_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 Summary

Constructors

Constructor	Description
StdContainerWrapper()

Method Summary

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.
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.
CMObject	newInstance()	Returns a new instance of this class.
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.
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 hasADoor, boolean isOpen, boolean defaultsClosed, boolean hasALock, boolean isLocked, boolean defaultsLocked)	Modifies the various door/lock settings for this thing.
void	setKeyName(java.lang.String keyName)	For things with doors and locks, this sets the unique string representing the key code required to unlock/lock it.
void	setOpenDelayTicks(int numTicks)	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.
void	setWrappedObject(CMObject obj)	Set the object wrapped by this one.

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

addBehavior, addScript, behaviors, delAllBehaviors, delAllScripts, delBehavior, delScript, eachBehavior, eachScript, fetchBehavior, fetchBehavior, fetchScript, numBehaviors, numScripts, scripts

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

copyOf, initializeClass

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

getWrappedObject

Methods inherited from interface java.lang.Comparable

compareTo

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

canSaveDatabaseID, databaseID, setDatabaseID

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

baseGoldValue, container, material, numberOfItems, owner, rawSecretIdentity, recursiveWeight, removeFromOwnerContainer, secretIdentity, setBaseValue, setContainer, setMaterial, setOwner, setSecretIdentity, setUsesRemaining, stopTicking, subjectToWearAndTear, ultimateContainer, usesRemaining, value

Methods inherited from class java.lang.Object

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

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

isReadable, readableText, setReadable, setReadableText

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

riding, setRiding

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

addBehavior, addEffect, addNonUninvokableEffect, addScript, affectCharState, affectCharStats, affectPhyStats, amBeingWornProperly, amDestroyed, amWearingAt, baseGoldValue, basePhyStats, behaviors, canSaveDatabaseID, canWear, compareProperLocations, compareTo, container, copyOf, databaseID, delAllBehaviors, delAllEffects, delAllScripts, delBehavior, delEffect, delScript, description, description, destroy, displayText, displayText, eachBehavior, eachEffect, eachScript, effects, executeMsg, expirationDate, fetchBehavior, fetchBehavior, fetchEffect, fetchEffect, fetchScript, fitsOn, genericName, getSaveStatIndex, getStat, getStatCodes, getTickStatus, getWrappedObject, image, initializeClass, isGeneric, isReadable, isSavable, isStat, L, material, maxRange, minRange, miscTextFormat, name, name, Name, numBehaviors, numberOfItems, numEffects, numScripts, okMessage, owner, phyStats, rawImage, rawLogicalAnd, rawProperLocationBitmap, rawSecretIdentity, rawWornCode, readableText, recoverPhyStats, recursiveWeight, removeFromOwnerContainer, riding, sameAs, scripts, secretIdentity, setBasePhyStats, setBaseValue, setContainer, setDatabaseID, setDescription, setDisplayText, setExpirationDate, setImage, setMaterial, setMiscText, setName, setOwner, setRawLogicalAnd, setRawProperLocationBitmap, setRawWornCode, setReadable, setReadableText, setRiding, setSavable, setSecretIdentity, setStat, setUsesRemaining, stopTicking, subjectToWearAndTear, text, tick, ultimateContainer, unWear, usesRemaining, value, wearAt, wearEvenIfImpossible, wearIfPossible, wearIfPossible, whereCantWear

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

amBeingWornProperly, amWearingAt, canWear, compareProperLocations, fitsOn, rawLogicalAnd, rawProperLocationBitmap, rawWornCode, setRawLogicalAnd, setRawProperLocationBitmap, setRawWornCode, unWear, wearAt, wearEvenIfImpossible, wearIfPossible, wearIfPossible, whereCantWear

Field Detail

container

protected Container container

Constructor Detail

StdContainerWrapper

public StdContainerWrapper()

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, Tech. The name is typically identical to the class name.

Specified by:

ID in interface CMObject

Overrides:

ID in class StdItemWrapper

Returns:

the name of this class

setWrappedObject

public void setWrappedObject(CMObject obj)

Description copied from interface: CMObjectWrapper

Set the object wrapped by this one.

Specified by:

setWrappedObject in interface CMObjectWrapper

Overrides:

setWrappedObject in class StdItemWrapper

Parameters:

obj - the object to wrap

newInstance

public CMObject newInstance()

Description copied from interface: CMObject

Returns a new instance of this class.

Specified by:

newInstance in interface CMObject

Overrides:

newInstance in class StdItemWrapper

Returns:

a new instance of this class

isOpen

public boolean isOpen()

Description copied from interface: CloseableLockable

Returns whether this is OPEN and may be accessed or travelled through

Specified by:

isOpen in interface CloseableLockable

Returns:

whether this is OPEN and may be accessed or travelled through

isLocked

public boolean isLocked()

Description copied from interface: CloseableLockable

Returns whether this is LOCKED, and must be unlocked before being used.

Specified by:

isLocked in interface CloseableLockable

Returns:

true if locked, false otherwise

See Also:

CloseableLockable.hasADoor(), CloseableLockable.hasALock()

hasADoor

public boolean hasADoor()

Description copied from interface: CloseableLockable

Returns whether this has a door, and must be opened before being used.

Specified by:

hasADoor in interface CloseableLockable

Returns:

true if a door is present, false otherwise.

See Also:

CloseableLockable.isOpen(), CloseableLockable.isLocked()

hasALock

public boolean hasALock()

Description copied from interface: CloseableLockable

Returns whether this has a lock on it, and, if locked, must be unlocked before being used.

Specified by:

hasALock in interface CloseableLockable

Returns:

whether a lock is present

See Also:

CloseableLockable.isOpen(), CloseableLockable.isLocked(), CloseableLockable.hasADoor()

defaultsLocked

public boolean defaultsLocked()

Description copied from interface: CloseableLockable

For exits with a door and lock, this returns whether this defaults in a closed and locked state.

Specified by:

defaultsLocked in interface CloseableLockable

Returns:

true if defaults closed and locked, false otherwise

See Also:

CloseableLockable.hasADoor(), CloseableLockable.defaultsClosed()

defaultsClosed

public boolean defaultsClosed()

Description copied from interface: CloseableLockable

For exits with a door, this returns whether this defaults in a closed state.

Specified by:

defaultsClosed in interface CloseableLockable

Returns:

true if defaults closed, false otherwise

See Also:

CloseableLockable.hasADoor(), CloseableLockable.defaultsLocked()

setDoorsNLocks

public void setDoorsNLocks(boolean hasADoor,
                           boolean isOpen,
                           boolean defaultsClosed,
                           boolean hasALock,
                           boolean isLocked,
                           boolean defaultsLocked)

Description copied from interface: CloseableLockable

Modifies the various door/lock settings for this thing.

Specified by:

setDoorsNLocks in interface CloseableLockable

Parameters:

hasADoor - whether this has a door

isOpen - whether this is open for use

defaultsClosed - whether this defaults closed

hasALock - whether this has a lock

isLocked - whether this is presently locked

defaultsLocked - whether this defaults closed and locked.

See Also:

CloseableLockable.isOpen(), CloseableLockable.isLocked(), CloseableLockable.hasADoor(), CloseableLockable.hasALock(), CloseableLockable.defaultsClosed(), CloseableLockable.defaultsLocked()

keyName

public java.lang.String keyName()

Description copied from interface: CloseableLockable

For things with doors and locks, this returns the unique string representing the key code required to unlock/lock it.

Specified by:

keyName in interface CloseableLockable

Returns:

the key code

See Also:

CloseableLockable.setKeyName(String)

setKeyName

public void setKeyName(java.lang.String keyName)

Description copied from interface: CloseableLockable

For things with doors and locks, this sets the unique string representing the key code required to unlock/lock it.

Specified by:

setKeyName in interface CloseableLockable

Parameters:

keyName - the new key code

See Also:

CloseableLockable.keyName()

openDelayTicks

public int openDelayTicks()

Description copied from interface: CloseableLockable

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.

Specified by:

openDelayTicks in interface CloseableLockable

Returns:

the number of ticks this remains open

See Also:

CloseableLockable.setOpenDelayTicks(int), Tickable.TICKID_EXIT_REOPEN

setOpenDelayTicks

public void setOpenDelayTicks(int numTicks)

Description copied from interface: CloseableLockable

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.

Specified by:

setOpenDelayTicks in interface CloseableLockable

Parameters:

numTicks - the number of ticks this will remain open

See Also:

CloseableLockable.openDelayTicks(), Tickable.TICKID_EXIT_REOPEN

getDeepContents

public ReadOnlyList<Item> getDeepContents()

Description copied from interface: Container

Returns all the items in this container, including other containers and THEIR contents, recursively.

Specified by:

getDeepContents in interface Container

Returns:

all the items in this container, recursively

See Also:

Container.getContents()

getContents

public ReadOnlyList<Item> getContents()

Description copied from interface: Container

Returns all the immediate items in this container, including other containers, but not the contents of those innner containers. Just the first level contents of this container.

Specified by:

getContents in interface Container

Returns:

all the immediate items in this container

See Also:

Container.getDeepContents()

capacity

public int capacity()

Description copied from interface: Container

Returns the maximum weight that can fit inside this container. Weight is used as a proxy for volume in CoffeeMud.

Specified by:

capacity in interface Container

Returns:

the maximum weight that can fit inside this container

See Also:

Container.setCapacity(int)

setCapacity

public void setCapacity(int newValue)

Description copied from interface: Container

Sets the maximum weight that can fit inside this container. Weight is used as a proxy for volume in CoffeeMud.

Specified by:

setCapacity in interface Container

Parameters:

newValue - the maximum weight that can fit inside this container

See Also:

Container.capacity()

hasContent

public boolean hasContent()

Description copied from interface: Container

Returns whether there is anything at all in this container.

Specified by:

hasContent in interface Container

Returns:

true if there is anything in this container, false if it is empty

canContain

public boolean canContain(Item I)

Description copied from interface: Container

Returns whether this container is allowed to contain the given object.

Specified by:

canContain in interface Container

Parameters:

I - the item to check against the allowed content

Returns:

true if the given item can go in this container, false otherwise

See Also:

Container.setContainTypes(long), Container.containTypes()

isInside

public boolean isInside(Item I)

Description copied from interface: Container

Returns whether the given item is, in fact, inside this container, even recursively. So if the given item is in a container, and that container is in THIS container, it would still be inside.

Specified by:

isInside in interface Container

Parameters:

I - the item to check against the content

Returns:

true if the item is somewhere inside, false otherwise

containTypes

public long containTypes()

Description copied from interface: Container

Returns a bitmap of the types of things that this container can hold.

Specified by:

containTypes in interface Container

Returns:

a bitmap of the types of things that this container can hold

See Also:

Container.setContainTypes(long), Container.CONTAIN_ANYTHING, Container.CONTAIN_DESCS

setContainTypes

public void setContainTypes(long containTypes)

Description copied from interface: Container

Sets a bitmap of the types of things that this container can hold.

Specified by:

setContainTypes in interface Container

Parameters:

containTypes - a bitmap of the types of things that this container can hold.

See Also:

Container.containTypes(), Container.CONTAIN_ANYTHING, Container.CONTAIN_DESCS

emptyPlease

public void emptyPlease(boolean flatten)

Description copied from interface: Container

Empties this container into its owner.

Specified by:

emptyPlease in interface Container

Parameters:

flatten - if true, will also remove all recursive items from their containers