com.planet_ink.coffee_mud.core.interfaces
Interface Readable

All Superinterfaces:
Affectable, java.lang.Cloneable, CMObject, java.lang.Comparable<CMObject>, Contingent, Environmental, Modifiable, MsgListener, Physical, StatsAffecting, Tickable
All Known Subinterfaces:
Ammunition, AmmunitionWeapon, Armor, Book, CagedAnimal, ClanItem, Coins, Computer, Container, DeadBody, DeckOfCards, DoorKey, ElecPanel, Electronics, Exit, FalseLimb, Food, FuelConsumer, HandOfCards, InnKey, Item, Light, MagicDust, MiscMagic, MusicalInstrument, PackagedItems, Pill, PlayingCard, Potion, PowerGenerator, PowerSource, PrepositionExit, RawMaterial, Recipe, RoomMap, SailingShip, Scroll, Shield, ShipEngine, ShipWarComponent, Software, SpellHolder, TechComponent, Technical, Wand, Weapon
All Known Implementing Classes:
AjarDoor, Apple, ArchonJournal, ArchonStaff, Arquebus, Asteroid, Backpack, BagOfEndlessness, BagOfHolding, BandedArmor, BardMap, BattleAxe, Bed, Boat, Broom, Cestus, ChainMailArmor, ChainMailVest, Chair, Claymore, ClimbableExit, CloseableContainer, Corpse, Dagger, DaggerOfVenom, Dirk, Door, DragonClaw, Dress, DrowChainMailArmor, DrowDagger, DrowMace, DrowQuarterstaff, DrowSword, DruidicMonument, DwarfStar, EmissionScanProgram, EternityBarkArmor, EternityLeafArmor, EternityLeafShield, EternityQuarterstaff, FieldPlate, FlamingSword, FlyingExit, FullPlate, GapExit, GasGiant, Gate, Gem, GenAbsorbantShield, GenAirLock, GenAmmunition, GenArmor, GenBagOfEndlessness, GenBed, GenBelt, GenBlaster, GenBoat, GenBoffWeapon, GenBook, GenBow, GenBussardCollector, GenCage, GenCaged, GenCageRideable, GenChair, GenCigar, GenClanApron, GenClanCard, GenClanCommonContainer, GenClanCommonItem, GenClanContainer, GenClanDonationList, GenClanFlag, GenClanItem, GenClanPamphlet, GenClanSpecialItem, GenCloak, GenCoins, GenCompBattery, GenCompEnviroSystem, GenCompGenerator, GenComputerConsole, GenContainer, GenCorpse, GenCurtain, GenDeflectionShield, GenDice, GenDisruptor, GenDisruptor2, GenDissertation, GenDoor, GenDress, GenDrink, GenEarring, GenEclipseField, GenElecCompItem, GenElecCompSensor, GenElecContainer, GenElecItem, GenElecPanel, GenElecWeapon, GenEmptyDrink, GenEnergyShield, GenExit, GenFatWallpaper, GenFood, GenFoodResource, GenFountain, GenFuellessGenerator, GenGrapples, GenGraviticSensor, GenHandBow, GenInstrument, GenIntegrityShield, GenItem, GenJournal, GenKey, GenKineticField, GenLantern, GenLaserGun, GenLasso, GenLawBook, GenLightSource, GenLightSwitch, GenLimb, GenLiquidResource, GenMap, GenMirror, GenMobilePortal, GenMultiPotion, GenMutingField, GenNet, GenPackagedItems, GenPackagedStack, GenPackagedVariety, GenPants, GenPaper, GenPerfume, GenPersonalShield, GenPhaser, GenPhaser2, GenPiano, GenPill, GenPipe, GenPlayerBook, GenPlayingCard, GenPortal, GenPotion, GenPowder, GenReadable, GenRecipe, GenReflectionShield, GenResource, GenRideable, GenRuinedItem, GenSailingShip, GenScroll, GenShield, GenShipDampener, GenShipEngine, GenShipGravityGen, GenShipPanel, GenShipProgram, GenShipShieldGenerator, GenShipThruster, GenShipWeapon, GenShirt, GenShoes, GenSiegeWeapon, GenSling, GenSoftware, GenSolarGenerator, GenSonicGun, GenSpaceBody, GenSpaceDrive, GenSpaceShip, GenSpaceTech, GenSpear, GenStaff, GenStealthShield, GenSuperPill, GenTable, GenTechItem, GenThinArmor, GenTickerShield, GenTitle, GenTriCorder, GenTub, GenWallpaper, GenWand, GenWater, GenWaterPowerGenerator, GenWeapon, GenWindGenerator, Glaive, GlovesSpeed, GlowingMageArmor, GoodyBag, Grate, GreatHelm, Halberd, Hat, Hat_Intelligence, HealthScanProgram, Helmet, HerbChest, HiddenClosedDoorway, HiddenWalkway, HideArmor, HoleInTheGround, HolyAvenger, Hood, HorseCart, Impassable, Ingredients, Javelin, Katana, Lantern, LargeChest, LargeSack, LeatherArmor, LeatherBoots, LeatherBracers, LeatherCap, LeatherGauntlets, LifeFountain, LifeScanProgram, LightSource, LockableContainer, LockedDoor, LockedGate, Longsword, Mace, ManualAdvancement, ManualArchon, ManualClasses, MassiveStar, MetalBracers, MichaelsMithrilChain, Moonlet, Natural, NeedleChest, NeedleDoor, OilFlask, Open, OpenDescriptable, OpenNameable, OpenPrepositional, PaddedArmor, Pan, Pants, Parchment, PitOpen, 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, ShipTelnetProgram, Shirt, Shoes, Shortsword, Sickle, SmallChest, SmallDagger, SmallMace, SmallSack, SplintMail, Spring, Staff, Star, StdArmor, StdBoardable, StdBoffWeapon, StdBook, StdBow, StdCage, StdCageRideable, StdClanApron, StdClanCard, StdClanCommonContainer, StdClanCommonItem, StdClanContainer, StdClanDonationList, StdClanFlag, StdClanItem, StdClanPamphlet, StdClanSpecialItem, StdClosedDoorway, StdCoins, StdCompBattery, StdCompFuelConsumer, StdCompFuellessGenerator, StdCompGenerator, StdCompPanel, StdComputerConsole, StdContainer, StdDeckOfCards, StdDice, StdDissertation, StdDrink, StdElecCompContainer, StdElecCompItem, StdElecCompSensor, StdElecContainer, StdElecItem, StdElecPanel, StdElecWeapon, StdExit, StdFood, StdGrapples, StdHandOfCards, StdInnKey, StdItem, StdJournal, StdKey, StdLasso, StdLawBook, StdLimb, StdLockedDoorway, StdMap, StdNet, StdOpenDoorway, StdPaper, StdPerfume, StdPersonalShield, StdPill, StdPlayerBook, StdPlayingCard, StdPortal, StdPotion, StdPowder, StdProgram, StdRideable, StdScroll, StdShield, StdShipDampener, StdShipEngine, StdShipFuellessThruster, StdShipGravityGen, StdShipShieldGenerator, StdShipThruster, StdShipWeapon, StdSiegeWeapon, StdSling, StdSmokable, StdSpaceBody, StdSpaceTech, StdSpear, StdTechItem, StdThinArmor, StdTitle, StdTriCorder, StdTub, StdWand, StdWeapon, SteelGauntlets, Stiletto, StuddedLeatherArmor, Sword, ThreadbareRobes, ThrowingStone, Torch, TrainingSession, TrappedChest, TrappedDoor, TrappedLockedDoor, Trident, TwoHandedSword, UnseenWalkway, WalkingBoots, Wand_Advancement, Wand_Fire, Wand_Nourishment, WandArchon, WarHammer, Waterskin, Whip, Wineskin

public interface Readable
extends Physical

Something that can potentially be read, because it may or may not have writing on it.

See Also:
Physical

Field Summary
 
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
 
Method Summary
 boolean isReadable()
          Returns whether this thing is readable when the player uses the READ command and targets it.
 java.lang.String readableText()
          For things that are readable, this returns the readable string for this thing.
 void setReadable(boolean isTrue)
          Returns whether this thing is readable when the player uses the READ command and targets it.
 void setReadableText(java.lang.String text)
          For things that are readable, this set the readable string for this thing.
 
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
 

Method Detail

readableText

java.lang.String readableText()
For things that are readable, this returns the readable string for this thing. That is to say, what the player sees when they read the door.

Returns:
the readable string
See Also:
isReadable(), setReadable(boolean), setReadableText(String)

isReadable

boolean isReadable()
Returns whether this thing is readable when the player uses the READ command and targets it.

Returns:
true if the thing is readable.
See Also:
readableText(), setReadable(boolean), setReadableText(String)

setReadable

void setReadable(boolean isTrue)
Returns whether this thing is readable when the player uses the READ command and targets it. Readable text should also be set or unset.

Parameters:
isTrue - true if the thing is readable, and false otherwise
See Also:
readableText(), isReadable(), setReadableText(String)

setReadableText

void setReadableText(java.lang.String text)
For things that are readable, this set the readable string for this thing. That is to say, what the player sees when they read the door.

Parameters:
text - the readable text
See Also:
isReadable(), setReadable(boolean), readableText()