com.planet_ink.coffee_mud.Items.interfaces
Interface Container

All Superinterfaces:

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

All Known Subinterfaces:

Armor, DeadBody, DeckOfCards, HandOfCards, Shield

All Known Implementing Classes:

Backpack, BagOfEndlessness, BagOfHolding, BandedArmor, Bed, Boat, ChainMailArmor, ChainMailVest, Chair, CloseableContainer, Corpse, Dress, DrowChainMailArmor, EternityBarkArmor, EternityLeafArmor, EternityLeafShield, FieldPlate, FullPlate, GenArmor, GenBed, GenBelt, GenBoat, GenCage, GenCageRideable, GenChair, GenCigar, GenClanCommonContainer, GenClanContainer, GenCloak, GenContainer, GenCorpse, GenDress, GenDrink, GenElecContainer, GenFountain, GenLiquidResource, GenMobilePortal, GenMultiPotion, GenPants, GenPerfume, GenPiano, GenPipe, GenPortal, GenPotion, GenRideable, GenShield, GenShipContainer, GenShirt, GenShoes, GenSSConsole, GenSSPanel, GenSSPortal, GenTable, GenTub, GenWater, GlovesSpeed, GlowingMageArmor, GoodyBag, GreatHelm, Hat, Hat_Intelligence, Helmet, HerbChest, HideArmor, Hood, HorseCart, Ingredients, LargeChest, LargeSack, LeatherArmor, LeatherBoots, LeatherBracers, LeatherCap, LeatherGauntlets, LifeFountain, LockableContainer, MetalBracers, MichaelsMithrilChain, NeedleChest, OilFlask, PaddedArmor, Pan, Pants, PortableHole, Pot, RingMail, Robes, ScaleMail, Shirt, Shoes, SmallChest, SmallSack, SplintMail, Spring, StdArmor, StdCage, StdCageRideable, StdClanCommonContainer, StdClanContainer, StdContainer, StdDeckOfCards, StdDrink, StdElecContainer, StdHandOfCards, StdPerfume, StdPortal, StdPotion, StdRideable, StdShield, StdShipConsole, StdShipContainer, StdSmokable, StdTub, SteelGauntlets, StuddedLeatherArmor, ThreadbareRobes, TrappedChest, WalkingBoots, Waterskin, Wineskin

public interface Container
extends Item

Nested Class Summary

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

Wearable.CODES

Field Summary

static int	CONTAIN_ANYTHING
static int	CONTAIN_BODIES
static int	CONTAIN_CAGED
static int	CONTAIN_CLOTHES
static int	CONTAIN_COINS
static int	CONTAIN_DAGGERS
static java.lang.String[]	CONTAIN_DESCS
static int	CONTAIN_DRINKABLES
static int	CONTAIN_FOOTWEAR
static int	CONTAIN_KEYS
static int	CONTAIN_LIQUID
static int	CONTAIN_ONEHANDWEAPONS
static int	CONTAIN_OTHERWEAPONS
static int	CONTAIN_READABLES
static int	CONTAIN_SCROLLS
static int	CONTAIN_SMOKEABLES
static int	CONTAIN_SSCOMPONENTS
static int	CONTAIN_SWORDS

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

STATUS_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_CLAN, TICKID_CLANITEM, TICKID_DEADBODY_DECAY, TICKID_EMAIL, TICKID_EXIT_BEHAVIOR, TICKID_EXIT_REOPEN, TICKID_ITEM_BEHAVIOR, TICKID_ITEM_BOUNCEBACK, TICKID_LIGHT_FLICKERS, TICKID_LIVEAUCTION, TICKID_LONGERMASK, TICKID_MOB, TICKID_QUEST, TICKID_READYTOSTOP, TICKID_ROOM_BEHAVIOR, TICKID_ROOM_ITEM_REJUV, TICKID_SPELL_AFFECT, TICKID_TIMEAUCTION, TICKID_TRAP_DESTRUCTION, TICKID_TRAP_RESET, TICKMASK_SOLITARY

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_WEIGHT_POINTS, DEFAULT_WORN_WEIGHTS, FILTER_ANY, 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

Method Summary

boolean	canContain(Environmental E)
int	capacity()
long	containTypes()
void	emptyPlease()
ReadOnlyList<Item>	getContents()
boolean	hasALid()
boolean	hasALock()
boolean	isInside(Item I)
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.
void	setCapacity(int newValue)
void	setContainTypes(long containTypes)
void	setKeyName(java.lang.String keyName) 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)

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 interface com.planet_ink.coffee_mud.core.interfaces.Rider

riding, setRiding

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

description, displayText, expirationDate, image, isGeneric, maxRange, minRange, miscTextFormat, name, Name, rawImage, sameAs, setDescription, setDisplayText, setExpirationDate, setImage, setMiscText, setName, text

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

getTickStatus, tick

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

affectCharState, affectCharStats, affectPhyStats

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

executeMsg, okMessage

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

amDestroyed, destroy, isSavable, setSavable

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

copyOf, ID, initializeClass, newInstance

Methods inherited from interface java.lang.Comparable

compareTo

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

getSaveStatIndex, getStat, getStatCodes, isStat, setStat

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

addEffect, addNonUninvokableEffect, basePhyStats, delEffect, effects, fetchEffect, fetchEffect, numEffects, phyStats, recoverPhyStats, setBasePhyStats

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

addBehavior, addScript, behaviors, delBehavior, delScript, fetchBehavior, fetchBehavior, fetchScript, numBehaviors, numScripts, scripts

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

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

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

isReadable, readableText, setReadable, setReadableText

Field Detail

CONTAIN_ANYTHING

static final int CONTAIN_ANYTHING

See Also:

Constant Field Values

CONTAIN_LIQUID

static final int CONTAIN_LIQUID

See Also:

Constant Field Values

CONTAIN_COINS

static final int CONTAIN_COINS

See Also:

Constant Field Values

CONTAIN_SWORDS

static final int CONTAIN_SWORDS

See Also:

Constant Field Values

CONTAIN_DAGGERS

static final int CONTAIN_DAGGERS

See Also:

Constant Field Values

CONTAIN_OTHERWEAPONS

static final int CONTAIN_OTHERWEAPONS

See Also:

Constant Field Values

CONTAIN_ONEHANDWEAPONS

static final int CONTAIN_ONEHANDWEAPONS

See Also:

Constant Field Values

CONTAIN_BODIES

static final int CONTAIN_BODIES

See Also:

Constant Field Values

CONTAIN_READABLES

static final int CONTAIN_READABLES

See Also:

Constant Field Values

CONTAIN_SCROLLS

static final int CONTAIN_SCROLLS

See Also:

Constant Field Values

CONTAIN_CAGED

static final int CONTAIN_CAGED

See Also:

Constant Field Values

CONTAIN_KEYS

static final int CONTAIN_KEYS

See Also:

Constant Field Values

CONTAIN_DRINKABLES

static final int CONTAIN_DRINKABLES

See Also:

Constant Field Values

CONTAIN_CLOTHES

static final int CONTAIN_CLOTHES

See Also:

Constant Field Values

CONTAIN_SMOKEABLES

static final int CONTAIN_SMOKEABLES

See Also:

Constant Field Values

CONTAIN_SSCOMPONENTS

static final int CONTAIN_SSCOMPONENTS

See Also:

Constant Field Values

CONTAIN_FOOTWEAR

static final int CONTAIN_FOOTWEAR

See Also:

Constant Field Values

CONTAIN_DESCS

static final java.lang.String[] CONTAIN_DESCS

Method Detail

isLocked

boolean isLocked()

hasALock

boolean hasALock()

isOpen

boolean isOpen()

hasALid

boolean hasALid()

setLidsNLocks

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

getContents

ReadOnlyList<Item> getContents()

capacity

int capacity()

setCapacity

void setCapacity(int newValue)

canContain

boolean canContain(Environmental E)

isInside

boolean isInside(Item I)

containTypes

long containTypes()

setContainTypes

void setContainTypes(long containTypes)

emptyPlease

void emptyPlease()

keyName

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.

Returns:

the key code

See Also:

setKeyName(String)

setKeyName

void setKeyName(java.lang.String keyName)

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

Parameters:

keyName - the new key code

See Also:

keyName()