Wearable

All Superinterfaces:

java.lang.Cloneable, CMObject, java.lang.Comparable<CMObject>, Contingent, Environmental, Expireable, Modifiable, MsgListener, StatsAffecting, Tickable

All Known Subinterfaces:

Ammunition, AmmunitionWeapon, Armor, BodyToken, Book, CagedAnimal, ClanItem, Coins, Computer, Container, DeadBody, DeckOfCards, DoorKey, ElecPanel, Electronics, FalseLimb, Food, FuelConsumer, HandOfCards, InnKey, Item, Light, MagicDust, MiscMagic, MusicalInstrument, NavigableItem, PackagedItems, Pill, PlayingCard, Potion, PowerGenerator, PowerSource, RawMaterial, RecipesBook, RoomMap, Scroll, Shield, ShipDirectional, ShipEngine, ShipWarComponent, SiegableItem, Software, SpaceObject.SpaceGateway, TechComponent, Technical, Wand, Weapon

All Known Implementing Classes:

Apple, ArchonJournal, ArchonStaff, Arquebus, Asteroid, Backpack, BagOfEndlessness, BagOfHolding, BandedArmor, BardMap, BattleAxe, Bed, Boat, Broom, Cestus, ChainMailArmor, ChainMailVest, Chair, Claymore, CloseableContainer, Corpse, CubicGate, Dagger, DaggerOfVenom, DatabaseProgram, Dirk, DragonClaw, Dress, DrowChainMailArmor, DrowDagger, DrowMace, DrowQuarterstaff, DrowSword, DruidicMonument, DwarfStar, EmissionScanProgram, EternityBarkArmor, EternityLeafArmor, EternityLeafShield, EternityQuarterstaff, FieldPlate, FlamingSword, FullPlate, GasGiant, Gem, GenAbsorbantShield, GenAmmunition, GenArmor, GenBagOfEndlessness, GenBagOfHolding, GenBed, GenBelt, GenBlaster, GenBoardable, GenBoat, GenBoffWeapon, GenBook, GenBow, GenBussardCollector, GenCage, GenCaged, GenCageRideable, GenCannon, GenCaravan, GenCastle, GenChair, GenCigar, GenClanApron, GenClanArmor, GenClanCard, GenClanCastle, GenClanCommonContainer, GenClanCommonItem, GenClanConcierge, GenClanContainer, GenClanDonationList, GenClanFlag, GenClanItem, GenClanPamphlet, GenClanSailorsCap, GenClanSpecialItem, GenClanTabbard, GenCloak, GenCoins, GenCompBattery, GenCompEnviroSystem, GenCompGenerator, GenCompLauncher, GenComputerConsole, GenContainer, GenCorpse, GenDeflectionShield, GenDice, GenDisruptor, GenDisruptor2, GenDissertation, GenDress, GenDrink, GenEarring, GenEclipseField, GenElecCompItem, GenElecCompSensor, GenElecContainer, GenElecItem, GenElecPanel, GenElecWeapon, GenEmptyDrink, GenEnergyShield, GenFatWallpaper, GenFixture, GenFood, GenFoodResource, GenFountain, GenFuellessGenerator, GenFurniture, GenGangline, GenGiftContainer, GenGrapples, GenGraviticSensor, GenGun, GenHandBow, GenInstrument, GenIntegrityShield, GenItem, GenJournal, GenKey, GenKineticField, GenLantern, GenLaserGun, GenLasso, GenLawBook, GenLightSource, GenLightSwitch, GenLimb, GenLiquidResource, GenMagicInstrument, GenMap, GenMirror, GenMobilePortal, GenMultiPotion, GenMutingField, GenNavigableBoardable, GenNet, GenPackagedItems, GenPackagedStack, GenPackagedVariety, GenPants, GenPaper, GenPerfume, GenPersonalShield, GenPhaser, GenPhaser2, GenPiano, GenPill, GenPipe, GenPlayerBook, GenPlayingCard, GenPortal, GenPotion, GenPowder, GenQuestBoard, GenReadable, GenRecipe, GenReflectionShield, GenResource, GenRideable, GenRuinedItem, GenSailingShip, GenScale, GenScroll, GenShield, GenShipDampener, GenShipEngine, GenShipGravityGen, GenShipInertialBattery, GenShipOpticalSensor, GenShipPanel, GenShipProgram, GenShipShieldGenerator, GenShipThruster, GenShipViewScreen, GenShipWeapon, GenShipWindow, GenShirt, GenShoes, GenSiegableBoardable, GenSiegeWeapon, GenSling, GenSmartTorpedo, GenSoftware, GenSolarGenerator, GenSonicGun, GenSpaceBody, GenSpaceDrive, GenSpaceShip, GenSpaceTech, GenSpear, GenStaff, GenStealthShield, GenStove, GenSuperPill, GenTable, GenTechItem, GenTent, GenThinArmor, GenTickerShield, GenTitle, GenTorpedo, GenTriCorder, GenTub, GenWallpaper, GenWand, GenWater, GenWaterPowerGenerator, GenWeapon, GenWindGenerator, GenWormhole, Glaive, GlovesSpeed, GlowingMageArmor, GoodyBag, GreatHelm, Halberd, Hat, Hat_Intelligence, HealthScanProgram, Helmet, HerbChest, HideArmor, HoleInTheGround, HolyAvenger, Hood, HorseCart, Ingredients, Javelin, Katana, Lantern, LargeChest, LargeSack, LeatherArmor, LeatherBoots, LeatherBracers, LeatherCap, LeatherGauntlets, LifeFountain, LifeScanProgram, LightSource, LockableContainer, Longsword, Mace, ManualAdvancement, ManualArchon, ManualClasses, MassiveStar, MetalBracers, MichaelsMithrilChain, Moonlet, Natural, NeedleChest, OilFlask, PaddedArmor, Pan, Pants, Parchment, PortableHole, Pot, PracticePoint, Quarterstaff, QuestPoint, Rapier, Ration, Ring, Ring_Ornamental, Ring_Protection, RingMail, RingOfColdProtection, RingOfElectricity, RingOfFortitude, RingOfJustice, RingOfMagicResistance, Robes, RocketShipProgram, Ruler, Sabre, ScaleMail, Scimitar, ScrollSpell, SeaMap, ShieldWeapon, ShipDiagProgram, ShipNavProgram, ShipSensorProgram, ShipTacticalProgram, ShipTelnetProgram, Shirt, Shoes, Shortsword, Sickle, SmallChest, SmallDagger, SmallHammer, SmallMace, SmallSack, Spear, SplintMail, Spring, Staff, Star, StdArmor, StdBoardable, StdBoffWeapon, StdBook, StdBow, StdCage, StdCageRideable, StdClanApron, StdClanArmor, StdClanCard, StdClanCommonContainer, StdClanCommonItem, StdClanConcierge, StdClanContainer, StdClanDonationList, StdClanFlag, StdClanItem, StdClanPamphlet, StdClanSailorsCap, StdClanSpecialItem, StdClanTabbard, StdCoins, StdCompBattery, StdCompFuelConsumer, StdCompFuellessGenerator, StdCompGenerator, StdCompLauncher, StdCompPanel, StdComputerConsole, StdContainer, StdContainerWrapper, StdDeckOfCards, StdDice, StdDissertation, StdDrink, StdElecCompContainer, StdElecCompItem, StdElecCompSensor, StdElecContainer, StdElecItem, StdElecPanel, StdElecWeapon, StdFood, StdGrapples, StdGun, StdHandOfCards, StdInnKey, StdItem, StdItemWrapper, StdJournal, StdKey, StdLasso, StdLawBook, StdLimb, StdMap, StdNavigableBoardable, StdNet, StdPaper, StdPerfume, StdPersonalShield, StdPill, StdPlayerBook, StdPlayingCard, StdPortal, StdPortalWrapper, StdPotion, StdPowder, StdProgram, StdQuestBoard, StdRideable, StdRideableWrapper, StdScroll, StdShield, StdShipDampener, StdShipEngine, StdShipFuellessThruster, StdShipGravityGen, StdShipInertialBattery, StdShipShieldGenerator, StdShipThruster, StdShipWeapon, StdSiegableBoardable, StdSiegeWeapon, StdSling, StdSmartTorpedo, StdSmokable, StdSpaceBody, StdSpaceTech, StdSpaceTechWeapon, StdSpear, StdTechItem, StdThinArmor, StdThinItem, StdTitle, StdTorpedo, StdTriCorder, StdTub, StdWand, StdWeapon, StdWormhole, SteelGauntlets, Stiletto, StuddedLeatherArmor, Sword, ThreadbareRobes, ThrowingStone, Torch, TrainingSession, TrappedChest, Trident, TwoHandedSword, WalkingBoots, Wand_Advancement, Wand_Fire, Wand_Nourishment, WandArchon, WarHammer, Waterskin, Whip, Wineskin
```
public interface Wearable
extends Environmental
```

Nested Class Summary

Nested Classes
Modifier and Type Interface Description

static class Wearable.CODES
Global location stat code data collector

Nested Classes
Modifier and Type	Interface	Description
`static class`	`Wearable.CODES`	Global location stat code data collector

Field Summary

Fields
Modifier and Type	Field	Description
`static long[]`	`DEFAULT_WORN_CODES`	An array containing all of the worn codes,in the order of their numeric value.
`static long[]`	`DEFAULT_WORN_DEPENDENCYGRID`	A Chart, indexed by WORN_CODE, showing the other parts dependent on that one.
`static java.lang.String[]`	`DEFAULT_WORN_DESCS`	An array naming each of the worn location constants, in the order of their numeric value.
`static long[]`	`DEFAULT_WORN_ORDER`	An array representing all of the worn location bitmaps, except INVENTORY.
`static java.lang.String[]`	`DEFAULT_WORN_USUAL_NAMES`	An array naming each of the worn location constants, in the order of their numeric value.
`static double[][]`	`DEFAULT_WORN_WEIGHT_POINTS`	An array representing the relative weight of items made for each of the several worn locations, in the same order as their numeric value.
`static double[]`	`DEFAULT_WORN_WEIGHTS`	An array representing the armor protective strength of the worn location bitmaps, in the same order as their numeric value.
`static Filterer<Environmental>`	`FILTER_ANY`	a constant used in the Locale item search classes to filter on only items being worn OR not being worn
`static Filterer<Environmental>`	`FILTER_MOBINVONLY`	a constant used in the Locale item search classes to filter on only items in mob inventory
`static Filterer<Environmental>`	`FILTER_ROOMONLY`	a constant used in the Locale item search classes to filter on only items in a room
`static Filterer<Environmental>`	`FILTER_UNWORNONLY`	a constant used in the Locale item search classes to filter on only items NOT being worn
`static Filterer<Environmental>`	`FILTER_WORNONLY`	a constant used in the Locale item search classes to filter on only items being worn
`static long`	`HIGHEST_WORN_CODE`	highest possible worn code value
`static long`	`IN_INVENTORY`	worn code constant, representing being unworn altogether
`static long`	`WORN_ABOUT_BODY`	worn code constant, worn about the shoulders and the whole body
`static long`	`WORN_ARMS`	worn code constant, worn on both arms
`static long`	`WORN_BACK`	worn code constant, worn on the back
`static long`	`WORN_EARS`	worn code constant, worn on or around the ears
`static long`	`WORN_EYES`	worn code constant, worn on the eye area of the face
`static long`	`WORN_FEET`	worn code constant, worn on the feet
`static long`	`WORN_FLOATING_NEARBY`	worn code constant, floats nearby
`static long`	`WORN_HANDS`	worn code constant, worn on both hands
`static long`	`WORN_HEAD`	worn code constant, worn on the head
`static long`	`WORN_HELD`	worn code constant, worn on the held position
`static long`	`WORN_LEFT_FINGER`	worn code constant, worn on the left finger
`static long`	`WORN_LEFT_WRIST`	worn code constant, worn on the left wrist
`static long`	`WORN_LEGS`	worn code constant, worn on the legs
`static long`	`WORN_MOUTH`	worn code constant, worn on or in the mouth
`static long`	`WORN_NECK`	worn code constant, worn on the neck
`static long`	`WORN_RIGHT_FINGER`	worn code constant, worn on the right finger
`static long`	`WORN_RIGHT_WRIST`	worn code constant, worn on the right wrist
`static long`	`WORN_TORSO`	worn code constant, worn on the torso
`static long`	`WORN_WAIST`	worn code constant, worn on the waist
`static long`	`WORN_WIELD`	worn code constant, worn on the wield position

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

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

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`boolean`	`amBeingWornProperly()`	Returns whether this item is being worn properly, regardless of layering or multi-restrictions.
`boolean`	`amWearingAt(long wornCode)`	Can test where, if anywhere, an item is being worn.
`boolean`	`canWear(MOB mob, long wornCode)`	Returns whether it is practical for the given mob to wear this Item on the given worn location as given by the wornCode.
`boolean`	`compareProperLocations(Item toThis)`	compares whether this item is allowed to be worn on the same locations as the given item.
`boolean`	`fitsOn(long wornCode)`	Whether this item is designated as being wearable on the given worn codes defined in the Item interface.
`boolean`	`rawLogicalAnd()`	Flag which determines whether the rawProperLocationBitmap represents the fact that it is worn on ALL locations (value of true) or worn on any of the locations.
`long`	`rawProperLocationBitmap()`	Returns the builder-defined bitmap made from a logical combination of the worn location constants from the Item interface.
`long`	`rawWornCode()`	Returns the bitmap representing where this item is presently being worn by the mob or player who has the item in his or inventory.
`void`	`setRawLogicalAnd(boolean newAnd)`	Sets flag which determines whether the rawProperLocationBitmap represents the fact that it is worn on ALL locations (value of true) or worn on any of the locations.
`void`	`setRawProperLocationBitmap(long newValue)`	Sets the builder-defined bitmap made from a logical combination of the worn location constants from the Item interface.
`void`	`setRawWornCode(long newValue)`	Sets the bitmap representing where this item is presently being worn by the mob or player who has the item in his or inventory.
`void`	`unWear()`	Removes this item from a state of being worn, and puts it back into the mob or player inventory.
`void`	`wearAt(long wornCode)`	This method is similar to the wearEvenIfImpossible method method above, except that it does not inspect this item for allowed wearable locations, but always puts the item on the wear location represented by the given wornCode bitmap.
`void`	`wearEvenIfImpossible(MOB mob)`	Puts this item into a state of being worn regardless of whether it is practical for the given mob to wear it -- for instance, even if an item is already being worn where this item wants to be worn, or if the player has no such limbs to wear this item.
`boolean`	`wearIfPossible(MOB mob)`	Using the canWear method, this method will put the item into a state of being worn only if it is practical for the given mob or player to wear this Item.
`boolean`	`wearIfPossible(MOB mob, long wearCode)`	Using the canWear method, this method will put the item into a state of being worn on the given location only if it is practical for the given mob or player to wear this Item at the given location.
`long`	`whereCantWear(MOB mob)`	Returns a bitmap of all the locations where the given mob is practically unable to wear an item.

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.Contingent
amDestroyed, destroy, isSavable, setSavable

Methods inherited from interface com.planet_ink.coffee_mud.core.interfaces.Environmental
description, displayText, image, isGeneric, L, maxRange, minRange, miscTextFormat, Name, rawImage, sameAs, setDescription, setDisplayText, setImage, setMiscText, setName, text

Methods inherited from interface com.planet_ink.coffee_mud.core.interfaces.Expireable
expirationDate, setExpirationDate

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.MsgListener
executeMsg, okMessage

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.Tickable
getTickStatus, name, tick

- Field Detail
  - FILTER_WORNONLY
```
static final Filterer<Environmental> FILTER_WORNONLY
```
    a constant used in the Locale item search classes to filter on only items being worn
  - FILTER_UNWORNONLY
```
static final Filterer<Environmental> FILTER_UNWORNONLY
```
    a constant used in the Locale item search classes to filter on only items NOT being worn
  - FILTER_MOBINVONLY
```
static final Filterer<Environmental> FILTER_MOBINVONLY
```
    a constant used in the Locale item search classes to filter on only items in mob inventory
  - FILTER_ROOMONLY
```
static final Filterer<Environmental> FILTER_ROOMONLY
```
    a constant used in the Locale item search classes to filter on only items in a room
  - FILTER_ANY
```
static final Filterer<Environmental> FILTER_ANY
```
    a constant used in the Locale item search classes to filter on only items being worn OR not being worn
  - IN_INVENTORY
```
static final long IN_INVENTORY
```
    worn code constant, representing being unworn altogether
    
    See Also:
    
    Constant Field Values
  - WORN_HEAD
```
static final long WORN_HEAD
```
    worn code constant, worn on the head
    
    See Also:
    
    Constant Field Values
  - WORN_NECK
```
static final long WORN_NECK
```
    worn code constant, worn on the neck
    
    See Also:
    
    Constant Field Values
  - WORN_TORSO
```
static final long WORN_TORSO
```
    worn code constant, worn on the torso
    
    See Also:
    
    Constant Field Values
  - WORN_ARMS
```
static final long WORN_ARMS
```
    worn code constant, worn on both arms
    
    See Also:
    
    Constant Field Values
  - WORN_LEFT_WRIST
```
static final long WORN_LEFT_WRIST
```
    worn code constant, worn on the left wrist
    
    See Also:
    
    Constant Field Values
  - WORN_RIGHT_WRIST
```
static final long WORN_RIGHT_WRIST
```
    worn code constant, worn on the right wrist
    
    See Also:
    
    Constant Field Values
  - WORN_LEFT_FINGER
```
static final long WORN_LEFT_FINGER
```
    worn code constant, worn on the left finger
    
    See Also:
    
    Constant Field Values
  - WORN_RIGHT_FINGER
```
static final long WORN_RIGHT_FINGER
```
    worn code constant, worn on the right finger
    
    See Also:
    
    Constant Field Values
  - WORN_FEET
```
static final long WORN_FEET
```
    worn code constant, worn on the feet
    
    See Also:
    
    Constant Field Values
  - WORN_HELD
```
static final long WORN_HELD
```
    worn code constant, worn on the held position
    
    See Also:
    
    Constant Field Values
  - WORN_WIELD
```
static final long WORN_WIELD
```
    worn code constant, worn on the wield position
    
    See Also:
    
    Constant Field Values
  - WORN_HANDS
```
static final long WORN_HANDS
```
    worn code constant, worn on both hands
    
    See Also:
    
    Constant Field Values
  - WORN_FLOATING_NEARBY
```
static final long WORN_FLOATING_NEARBY
```
    worn code constant, floats nearby
    
    See Also:
    
    Constant Field Values
  - WORN_WAIST
```
static final long WORN_WAIST
```
    worn code constant, worn on the waist
    
    See Also:
    
    Constant Field Values
  - WORN_LEGS
```
static final long WORN_LEGS
```
    worn code constant, worn on the legs
    
    See Also:
    
    Constant Field Values
  - WORN_EYES
```
static final long WORN_EYES
```
    worn code constant, worn on the eye area of the face
    
    See Also:
    
    Constant Field Values
  - WORN_EARS
```
static final long WORN_EARS
```
    worn code constant, worn on or around the ears
    
    See Also:
    
    Constant Field Values
  - WORN_ABOUT_BODY
```
static final long WORN_ABOUT_BODY
```
    worn code constant, worn about the shoulders and the whole body
    
    See Also:
    
    Constant Field Values
  - WORN_MOUTH
```
static final long WORN_MOUTH
```
    worn code constant, worn on or in the mouth
    
    See Also:
    
    Constant Field Values
  - WORN_BACK
```
static final long WORN_BACK
```
    worn code constant, worn on the back
    
    See Also:
    
    Constant Field Values
  - HIGHEST_WORN_CODE
```
static final long HIGHEST_WORN_CODE
```
    highest possible worn code value
    
    See Also:
    
    Constant Field Values
  - DEFAULT_WORN_ORDER
```
static final long[] DEFAULT_WORN_ORDER
```
    An array representing all of the worn location bitmaps, except INVENTORY. The array has worn location constants in the order in which they are presented to the user.
  - DEFAULT_WORN_WEIGHTS
```
static final double[] DEFAULT_WORN_WEIGHTS
```
    An array representing the armor protective strength of the worn location bitmaps, in the same order as their numeric value.
  - DEFAULT_WORN_WEIGHT_POINTS
```
static final double[][] DEFAULT_WORN_WEIGHT_POINTS
```
    An array representing the relative weight of items made for each of the several worn locations, in the same order as their numeric value. These weights are broken, in turn, into values for cloth, leather, and metal armors respectively.
  - DEFAULT_WORN_DESCS
```
static final java.lang.String[] DEFAULT_WORN_DESCS
```
    An array naming each of the worn location constants, in the order of their numeric value.
  - DEFAULT_WORN_USUAL_NAMES
```
static final java.lang.String[] DEFAULT_WORN_USUAL_NAMES
```
    An array naming each of the worn location constants, in the order of their numeric value.
  - DEFAULT_WORN_CODES
```
static final long[] DEFAULT_WORN_CODES
```
    An array containing all of the worn codes,in the order of their numeric value.
  - DEFAULT_WORN_DEPENDENCYGRID
```
static final long[] DEFAULT_WORN_DEPENDENCYGRID
```
    A Chart, indexed by WORN_CODE, showing the other parts dependent on that one.
- Method Detail
  - amWearingAt
```
boolean amWearingAt(long wornCode)
```
    Can test where, if anywhere, an item is being worn. The value may be 0 to see if the item is not being worn (since 0 means inventory) or a combination of 1 or more of the worn codes listed in the Item interface.
    
    Parameters:
    
    wornCode - either 0, or one or more worn codes
    
    Returns:
    
    whether this item is being worn on the wornCode location
    
    See Also:
    
    Item
  - fitsOn
```
boolean fitsOn(long wornCode)
```
    Whether this item is designated as being wearable on the given worn codes defined in the Item interface. This method does not care about the practicality of wearing for a given mob (in other words, whether an item is already being worn on the location is not checked).
    
    Parameters:
    
    wornCode - the worn code to check, as defined in the Item interface
    
    Returns:
    
    whether this item is allowed to be worn on that location
    
    See Also:
    
    Item
  - whereCantWear
```
long whereCantWear(MOB mob)
```
    Returns a bitmap of all the locations where the given mob is practically unable to wear an item. The method compares items the mob is currently wearing to all possible wear locations, including locations where the mob can't wear things, and returns a bitmap representing all of those unwearable locations. The bitmap is constructed using the bitmap constants defined in the Item interface.
    
    Parameters:
    
    mob - the player or mob to evaluate for unwearable locations
    
    Returns:
    
    a bitmap made up of unwearable location bitmaps, from constants in Item interface
    
    See Also:
    
    Item
  - canWear
```
boolean canWear(MOB mob,
                long wornCode)
```
    Returns whether it is practical for the given mob to wear this Item on the given worn location as given by the wornCode. The method checks for existing limbs and wear locations, and for items already being worn by the mob, and finally determines if the worn location given by the wornCode is among the available slots.
    
    Parameters:
    
    mob - the player or mob being evaluated
    
    wornCode - the worn location to check and see if this Item can be worn there.
    
    Returns:
    
    whether this item can be worn by the given player at the given wornCode
    
    See Also:
    
    Item
  - wearIfPossible
```
boolean wearIfPossible(MOB mob)
```
    Using the canWear method, this method will put the item into a state of being worn only if it is practical for the given mob or player to wear this Item. The mob or player must have the item in his or her inventory first.
    
    Parameters:
    
    mob - the player or mob to put this item on.
    
    Returns:
    
    true if the item was wearable
  - wearIfPossible
```
boolean wearIfPossible(MOB mob,
                       long wearCode)
```
    Using the canWear method, this method will put the item into a state of being worn on the given location only if it is practical for the given mob or player to wear this Item at the given location. The mob or player must have the item in his or her inventory first.
    
    Parameters:
    
    mob - the player or mob to put this item on.
    
    wearCode - the bitmap wear code for the location to attempt
    
    Returns:
    
    true if the item was wearable at the location
  - wearEvenIfImpossible
```
void wearEvenIfImpossible(MOB mob)
```
    Puts this item into a state of being worn regardless of whether it is practical for the given mob to wear it -- for instance, even if an item is already being worn where this item wants to be worn, or if the player has no such limbs to wear this item. None of that matter to this method. The item must be in the mobs inventory first.
    
    Parameters:
    
    mob - the player or mob
  - wearAt
```
void wearAt(long wornCode)
```
    This method is similar to the wearEvenIfImpossible method method above, except that it does not inspect this item for allowed wearable locations, but always puts the item on the wear location represented by the given wornCode bitmap. This bitmap is made up of constants from the Item interface.
    
    Parameters:
    
    wornCode - the bitmap from Item interface constants used
    
    See Also:
    
    Item, wearEvenIfImpossible(MOB)
  - amBeingWornProperly
```
boolean amBeingWornProperly()
```
    Returns whether this item is being worn properly, regardless of layering or multi-restrictions. If the item is unworn, or floating via magic, it will return false. Otherwise true.
    
    Returns:
    
    true if its being properly worn.
  - unWear
```
void unWear()
```
    Removes this item from a state of being worn, and puts it back into the mob or player inventory. setContainer(null) may still need be called to make the item visible to the players inventory.
  - rawWornCode
```
long rawWornCode()
```
    Returns the bitmap representing where this item is presently being worn by the mob or player who has the item in his or inventory. The value returned by this method is set by the wear* methods defined above. The bitmap is made up of a combination of the wear location constants from the Item interface.
    
    Returns:
    
    the current worn code for this item
    
    See Also:
    
    Item, wearAt(long), wearIfPossible(MOB), wearEvenIfImpossible(MOB)
  - setRawWornCode
```
void setRawWornCode(long newValue)
```
    Sets the bitmap representing where this item is presently being worn by the mob or player who has the item in his or inventory. The value set by this method is set by the wear* methods defined above. The bitmap is made up of a combination of the wear location constants from the Item interface.
    
    Parameters:
    
    newValue - the current worn code for this item
    
    See Also:
    
    Item, wearAt(long), wearIfPossible(MOB), wearEvenIfImpossible(MOB)
  - rawProperLocationBitmap
```
long rawProperLocationBitmap()
```
    Returns the builder-defined bitmap made from a logical combination of the worn location constants from the Item interface. When combined with the rawLogicalAnd() method, it says whether this item is wearable on all of the locations defined by this bitmap at the same time or whether this item is wearable on any of the locations defined by this bitmap.
    
    Returns:
    
    the worn location bitmap defined by the Item interface.
    
    See Also:
    
    Item
  - setRawProperLocationBitmap
```
void setRawProperLocationBitmap(long newValue)
```
    Sets the builder-defined bitmap made from a logical combination of the worn location constants from the Item interface. When combined with the rawLogicalAnd() method, it says whether this item is wearable on all of the locations defined by this bitmap at the same time or whether this item is wearable on any of the locations defined by this bitmap.
    
    Parameters:
    
    newValue - the worn location bitmap defined by the Item interface.
    
    See Also:
    
    Item
  - rawLogicalAnd
```
boolean rawLogicalAnd()
```
    Flag which determines whether the rawProperLocationBitmap represents the fact that it is worn on ALL locations (value of true) or worn on any of the locations.
    
    Returns:
    
    whether this item is worn on all locations or any of the locations
    
    See Also:
    
    rawProperLocationBitmap()
  - setRawLogicalAnd
```
void setRawLogicalAnd(boolean newAnd)
```
    Sets flag which determines whether the rawProperLocationBitmap represents the fact that it is worn on ALL locations (value of true) or worn on any of the locations.
    
    Parameters:
    
    newAnd - whether this item is worn on all locations or any of the locations
    
    See Also:
    
    rawProperLocationBitmap()
  - compareProperLocations
```
boolean compareProperLocations(Item toThis)
```
    compares whether this item is allowed to be worn on the same locations as the given item.
    
    Parameters:
    
    toThis - the item to compare this items allowed worn locations to
    
    Returns:
    
    whether this item is allowed to be worn on the same place as the param

Interface Wearable

Nested Class Summary

Field Summary

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

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

Method Summary

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

Methods inherited from interface java.lang.Comparable

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

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

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

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

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

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

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

Field Detail

FILTER_WORNONLY

FILTER_UNWORNONLY

FILTER_MOBINVONLY

FILTER_ROOMONLY

FILTER_ANY

IN_INVENTORY

WORN_HEAD

WORN_NECK

WORN_TORSO

WORN_ARMS

WORN_LEFT_WRIST

WORN_RIGHT_WRIST

WORN_LEFT_FINGER

WORN_RIGHT_FINGER

WORN_FEET

WORN_HELD

WORN_WIELD

WORN_HANDS

WORN_FLOATING_NEARBY

WORN_WAIST

WORN_LEGS

WORN_EYES

WORN_EARS

WORN_ABOUT_BODY

WORN_MOUTH

WORN_BACK

HIGHEST_WORN_CODE

DEFAULT_WORN_ORDER

DEFAULT_WORN_WEIGHTS

DEFAULT_WORN_WEIGHT_POINTS

DEFAULT_WORN_DESCS

DEFAULT_WORN_USUAL_NAMES

DEFAULT_WORN_CODES

DEFAULT_WORN_DEPENDENCYGRID

Method Detail

amWearingAt

fitsOn

whereCantWear

canWear

wearIfPossible

wearIfPossible

wearEvenIfImpossible

wearAt

amBeingWornProperly

unWear

rawWornCode

setRawWornCode

rawProperLocationBitmap

setRawProperLocationBitmap

rawLogicalAnd

setRawLogicalAnd

compareProperLocations