com.planet_ink.coffee_mud.Items.interfaces
Interface CagedAnimal

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 Implementing Classes:

GenCaged

public interface CagedAnimal
extends Item

Represents a MOB being stored as an Item, such as a mob in a cage, or a baby. This interface allows the mob to be converted to the item, and back again.

Nested Class Summary

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

Wearable.CODES

Field Summary

static int

CAGEFLAG_TO_MOB_PROGRAMMATICALLY A Cage flag bit mask denoting that this caged animal should not automatically uncage itself, but may only do so programmatically.

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_BEAMWEAPON, TICKID_CLAN, TICKID_CLANITEM, TICKID_DEADBODY_DECAY, TICKID_ELECTRONICS, TICKID_EMAIL, 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_SOLITARYMASK, TICKID_SPECIALCOMBAT, TICKID_SPECIALMANEUVER, TICKID_SPELL_AFFECT, TICKID_SUPPORT, TICKID_TIMEAUCTION, TICKID_TRAP_DESTRUCTION, TICKID_TRAP_RESET

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

Method Summary

boolean	cageMe(MOB M) Cages the given mob, storing it in this Item object for uncaging later.
java.lang.String	cageText() Returns the raw xml text representing the mob stored in this item.
int	getCageFlagsBitmap() Returns the flag bitmap describing how this item behaves.
void	setCageFlagsBitmap(int bitmap) Sets the flag bitmap describing how this item behaves.
void	setCageText(java.lang.String text) Sets the raw xml text representing the mob stored in this item.
MOB	unCageMe() Uncages the mob previously stored in this item by returning the mob stored in this item.

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

description, displayText, name

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

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

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

getTickStatus, name, 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, delAllEffects, delEffect, eachEffect, effects, fetchEffect, fetchEffect, numEffects, phyStats, recoverPhyStats, setBasePhyStats

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

canSaveDatabaseID, databaseID, setDatabaseID

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

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

isReadable, readableText, setReadable, setReadableText

Field Detail

CAGEFLAG_TO_MOB_PROGRAMMATICALLY

static final int CAGEFLAG_TO_MOB_PROGRAMMATICALLY

A Cage flag bit mask denoting that this caged animal should not automatically uncage itself, but may only do so programmatically. A Baby, who is uncaged only through aging, is the classic example.

See Also:

setCageFlagsBitmap(int), getCageFlagsBitmap(), Constant Field Values

Method Detail

cageMe

boolean cageMe(MOB M)

Cages the given mob, storing it in this Item object for uncaging later. The mob must not be bound to a session. Does not otherwise affect the mob.

Parameters:

M - the mob to cage

Returns:

true if the caging was successful, false otherwise

See Also:

unCageMe()

unCageMe

MOB unCageMe()

Uncages the mob previously stored in this item by returning the mob stored in this item. Does not otherwise affect the item.

Returns:

the mob stored in this item, or null if a failure

See Also:

cageMe(MOB)

cageText

java.lang.String cageText()

Returns the raw xml text representing the mob stored in this item.

Returns:

the raw xml text representing the mob stored in this item.

See Also:

setCageText(String)

setCageText

void setCageText(java.lang.String text)

Sets the raw xml text representing the mob stored in this item.

Parameters:

text - the raw xml text representing the mob stored in this item.

See Also:

cageText()

getCageFlagsBitmap

int getCageFlagsBitmap()

Returns the flag bitmap describing how this item behaves.

Returns:

the flag bitmap describing how this item behaves.

See Also:

CAGEFLAG_TO_MOB_PROGRAMMATICALLY, setCageFlagsBitmap(int)

setCageFlagsBitmap

void setCageFlagsBitmap(int bitmap)

Sets the flag bitmap describing how this item behaves.

Parameters:

bitmap - the flag bitmap describing how this item behaves.

See Also:

CAGEFLAG_TO_MOB_PROGRAMMATICALLY, getCageFlagsBitmap()