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, Armor, CagedAnimal, ClanItem, Coins, Container, DeadBody, DeckOfCards, DoorKey, Electronics, Exit, Food, HandOfCards, InnKey, Item, Light, MagicDust, MiscMagic, MusicalInstrument, PackagedItems, Pill, PlayingCard, Potion, RawMaterial, Recipe, RoomMap, Scroll, Shield, ShipComponent, ShipComponent.ShipEngine, ShipComponent.ShipEnviroControl, ShipComponent.ShipPanel, ShipComponent.ShipPowerSource, ShipComponent.ShipSensor, ShipComponent.ShipWeapon, Software, SpellHolder, Wand, Weapon

All Known Implementing Classes:

ArchonJournal, ArchonStaff, Arquebus, 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, EternityBarkArmor, EternityLeafArmor, EternityLeafShield, EternityQuarterstaff, FieldPlate, FlamingSword, FlyingExit, FullPlate, GapExit, Gate, Gem, GenAirLock, GenAmmunition, GenArmor, GenBattery, GenBed, GenBelt, GenBoat, GenBoffWeapon, GenBook, GenBow, GenCage, GenCaged, GenCageRideable, GenChair, GenCigar, GenClanApron, GenClanCard, GenClanCommonContainer, GenClanCommonItem, GenClanContainer, GenClanDonationList, GenClanFlag, GenClanItem, GenClanPamphlet, GenClanSpecialItem, GenCloak, GenCoins, GenContainer, GenCorpse, GenDoor, GenDress, GenDrink, GenElecContainer, GenElecItem, GenExit, GenFatWallpaper, GenFood, GenFoodResource, GenFountain, GenHandBow, GenInstrument, GenItem, GenJournal, GenKey, GenLantern, GenLasso, GenLawBook, GenLightSource, GenLimb, GenLiquidResource, GenMap, GenMirror, GenMobilePortal, GenMultiPotion, GenNet, GenPackagedItems, GenPants, GenPerfume, GenPiano, GenPill, GenPipe, GenPortal, GenPotion, GenPowder, GenReadable, GenRecipe, GenResource, GenRideable, GenScroll, GenShield, GenShipComponent, GenShipContainer, GenShipItem, GenShirt, GenShoes, GenSling, GenSpear, GenSSBattery, GenSSConsole, GenSSEngine, GenSSEnviro, GenSSPanel, GenSSPortal, GenStaff, GenSuperPill, GenTable, GenTitle, GenTub, GenWallpaper, GenWand, GenWater, GenWeapon, Glaive, GlovesSpeed, GlowingMageArmor, GoodyBag, Grate, GreatHelm, Halberd, Hat, Hat_Intelligence, Helmet, HerbChest, HiddenClosedDoorway, HiddenWalkway, HideArmor, HolyAvenger, Hood, HorseCart, Impassable, Ingredients, Javelin, Katana, Lantern, LargeChest, LargeSack, LeatherArmor, LeatherBoots, LeatherBracers, LeatherCap, LeatherGauntlets, LifeFountain, LightSource, LockableContainer, LockedDoor, LockedGate, Longsword, Mace, ManualAdvancement, ManualArchon, ManualClasses, MetalBracers, MichaelsMithrilChain, Natural, NeedleChest, NeedleDoor, OilFlask, Open, OpenDescriptable, OpenNameable, PaddedArmor, Pan, Pants, Parchment, PitOpen, PortableHole, Pot, PracticePoint, Quarterstaff, QuestPoint, Rapier, Ration, Ring, Ring_Ornamental, Ring_Protection, RingMail, RingOfColdProtection, RingOfElectricity, RingOfFortitude, RingOfJustice, RingOfMagicResistance, Robes, Ruler, Sabre, ScaleMail, Scimitar, ScrollSpell, ShieldWeapon, Shirt, Shoes, Shortsword, Sickle, SmallChest, SmallDagger, SmallMace, SmallSack, SplintMail, Spring, Staff, StdArmor, StdBoffWeapon, StdBook, StdBow, StdCage, StdCageRideable, StdClanApron, StdClanCard, StdClanCommonContainer, StdClanCommonItem, StdClanContainer, StdClanDonationList, StdClanFlag, StdClanItem, StdClanPamphlet, StdClanSpecialItem, StdClosedDoorway, StdCoins, StdContainer, StdDeckOfCards, StdDrink, StdElecContainer, StdElecItem, StdExit, StdFood, StdHandOfCards, StdInnKey, StdItem, StdJournal, StdKey, StdLasso, StdLawBook, StdLimb, StdLockedDoorway, StdMap, StdNet, StdOpenDoorway, StdPerfume, StdPill, StdPlayingCard, StdPortal, StdPotion, StdPowder, StdProgram, StdRideable, StdScroll, StdShield, StdShipComponent, StdShipConsole, StdShipContainer, StdShipItem, StdSling, StdSmokable, StdSpear, StdTitle, StdTub, StdWand, StdWeapon, SteelGauntlets, Stiletto, StuddedLeatherArmor, Sword, ThreadbareRobes, ThrowingStone, Torch, TrainingSession, TrappedChest, TrappedDoor, TrappedLockedDoor, 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_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

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

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()