com.planet_ink.coffee_mud.Items.interfaces
Interface Armor
- 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:
- FalseLimb
- All Known Implementing Classes:
- BandedArmor, ChainMailArmor, ChainMailVest, Dress, DrowChainMailArmor, EternityBarkArmor, EternityLeafArmor, EternityLeafShield, FieldPlate, FullPlate, GenAbsorbantShield, GenArmor, GenBelt, GenCloak, GenDeflectionShield, GenDress, GenEarring, GenEclipseField, GenEnergyShield, GenIntegrityShield, GenKineticField, GenLimb, GenMutingField, GenPants, GenPersonalShield, GenReflectionShield, GenShield, GenShirt, GenShoes, GenStealthShield, GenThinArmor, GenTickerShield, GlovesSpeed, GlowingMageArmor, GreatHelm, Hat, Hat_Intelligence, Helmet, HideArmor, Hood, LeatherArmor, LeatherBoots, LeatherBracers, LeatherCap, LeatherGauntlets, MetalBracers, MichaelsMithrilChain, PaddedArmor, Pants, RingMail, Robes, ScaleMail, Shirt, Shoes, SplintMail, StdArmor, StdLimb, StdPersonalShield, StdShield, StdThinArmor, SteelGauntlets, StuddedLeatherArmor, ThreadbareRobes, WalkingBoots
public interface Armor
- extends Item
Interface for items which are complex wearables.
Since even the most basic of items can be held, most of the methods
that deal strictly with "Wearables" have their own interface.
- See Also:
This leaves the Armor interface just for the more complex aspects of
Wearability.
Nested Class Summary |
static class |
Armor.SizeDeviation
Different ways in which a piece of armor can fit, or not
fit, on a mob. |
Nested classes/interfaces inherited from interface com.planet_ink.coffee_mud.Items.interfaces.Wearable |
Wearable.CODES |
Field Summary |
static java.lang.String[] |
LAYERMASK_DESCS
Description string array for the LAYERMASK_ constants, in ordinal order,
as opposed to mask-value indexed. |
static short |
LAYERMASK_MULTIWEAR
Mask value for Armor which can be worn many times at the same layer. |
static short |
LAYERMASK_SEETHROUGH
Mask value for Armor which, when worn on the top layer, can be seen through. |
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 |
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.Environmental |
description, displayText, expirationDate, image, isGeneric, L, maxRange, minRange, miscTextFormat, Name, rawImage, sameAs, setDescription, setDisplayText, setExpirationDate, setImage, setMiscText, setName, text |
Methods inherited from interface java.lang.Comparable |
compareTo |
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.Items.interfaces.Wearable |
amBeingWornProperly, amWearingAt, canWear, compareProperLocations, fitsOn, rawLogicalAnd, rawProperLocationBitmap, rawWornCode, setRawLogicalAnd, setRawProperLocationBitmap, setRawWornCode, unWear, wearAt, wearEvenIfImpossible, wearIfPossible, wearIfPossible, whereCantWear |
LAYERMASK_DESCS
static final java.lang.String[] LAYERMASK_DESCS
- Description string array for the LAYERMASK_ constants, in ordinal order,
as opposed to mask-value indexed.
- See Also:
LAYERMASK_MULTIWEAR
,
LAYERMASK_SEETHROUGH
LAYERMASK_SEETHROUGH
static final short LAYERMASK_SEETHROUGH
- Mask value for Armor which, when worn on the top layer, can be seen through.
This allows the items worn at lower layers to be seen (unless they too are
see-through).
- See Also:
LAYERMASK_DESCS
,
LAYERMASK_MULTIWEAR
,
Constant Field Values
LAYERMASK_MULTIWEAR
static final short LAYERMASK_MULTIWEAR
- Mask value for Armor which can be worn many times at the same layer.
- See Also:
LAYERMASK_DESCS
,
LAYERMASK_SEETHROUGH
,
Constant Field Values
getClothingLayer
short getClothingLayer()
- Returns the layer at which this item is worn. 0 is the baseline layer, while
larger than 0 is things like coats and shawls, where less than 0 are things
like underwear and hose.
- Returns:
- the layer at which this item is worn.
- See Also:
setClothingLayer(short)
setClothingLayer
void setClothingLayer(short newLayer)
- Sets the layer at which this item is worn. 0 is the baseline layer, while
larger than 0 is things like coats and shawls, where less than 0 are things
like underwear and hose.
- Parameters:
newLayer
- the layer at which this item is worn.- See Also:
getClothingLayer()
getLayerAttributes
short getLayerAttributes()
- Returns the bitmask for the several layer attribute flags. See the flags
for more information on what they do.
- Returns:
- the bitmask for the several layer attribute flags
- See Also:
setLayerAttributes(short)
,
LAYERMASK_DESCS
,
LAYERMASK_MULTIWEAR
,
LAYERMASK_SEETHROUGH
setLayerAttributes
void setLayerAttributes(short newAttributes)
- Sets the bitmask for the several layer attribute flags. See the flags
for more information on what they do.
- Parameters:
newAttributes
- the bitmask for the several layer attribute flags- See Also:
getLayerAttributes()
,
LAYERMASK_DESCS
,
LAYERMASK_MULTIWEAR
,
LAYERMASK_SEETHROUGH
getSizingDeviation
Armor.SizeDeviation getSizingDeviation(MOB mob)
- Returns a coded description of how well this item fits on the
given mob. See the SizeDeviation object for more information
on the responses.
- Parameters:
mob
- the mob to compare the fittability of this armor to
- Returns:
- a coded description of how well this item fits
- See Also:
Armor.SizeDeviation