Affectable, Behavable, CMObject, Contingent, DBIdentifiable, Environmental, Expireable, Modifiable, MsgListener, Physical, PhysicalAgent, Readable, Rider, StatsAffecting, Tickable, Book, Item, Wearable, java.lang.Cloneable, java.lang.Comparable<CMObject>GenPaperpublic class StdPaper extends StdItem implements Book
Wearable.CODES| Modifier and Type | Field | Description |
|---|---|---|
protected int |
maxCharsPage |
idConverter_name, affectPhyStats, affects, baseGoldValue, basePhyStats, behaviors, cachedImageName, CODES, databaseID, description, destroyed, displayText, dispossessionTime, material, me, miscText, myContainer, myUses, myWornCode, owner, phyStats, properWornBitmap, rawImageName, riding, scripts, secretIdentity, tickCtr, tickStatus, wornLogicalAnd, xtraValuesSTATUS_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_RESETDEFAULT_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| Constructor | Description |
|---|---|
StdPaper() |
| Modifier and Type | Method | Description |
|---|---|---|
void |
addRawContent(java.lang.String authorName,
java.lang.String content) |
Adds a page to this book, or appends content if just a piece of paper.
|
boolean |
canRead(MOB mob) |
Returns whether the content is readable by the given mob/player.
|
boolean |
canWrite(MOB mob) |
Returns whether this can be written to by the given mob/player
|
java.lang.String |
genericName() |
Returns a generic name for this object, devoid of its particular
identifying details.
|
java.lang.String |
getContent(int page) |
Returns the readable content of a page
|
int |
getMaxCharsPerPage() |
Returns the maximum number of chars that can be written on
each page in this book.
|
int |
getMaxPages() |
Returns the maximum number of pages that can be written on
in this book.
|
java.lang.String |
getRawContent(int page) |
Returns the raw content of a page
|
int |
getUsedPages() |
Returns the number of pages with writing on them.
|
java.lang.String |
ID() |
The CoffeeMud Java Class ID shared by all instances of
this object.
|
boolean |
isJournal() |
Returns whether the content is shared among all similar items, or
is unique to this item or owner or a special key.
|
boolean |
okMessage(Environmental myHost,
CMMsg msg) |
The general message event previewer for the object.
|
java.lang.String |
readableText() |
For things that are readable, this returns the readable string
for this thing.
|
void |
setMaxCharsPerPage(int max) |
Sets the maximum number of chars that can be written on
each page in this book.
|
void |
setMaxPages(int max) |
Sets the maximum number of pages that can be written on
in this book.
|
void |
setReadableText(java.lang.String text) |
For things that are readable, this set the readable string
for this thing.
|
addEffect, addNonUninvokableEffect, basePhyStats, delAllEffects, delEffect, eachEffect, effects, fetchEffect, fetchEffect, numEffects, phyStats, recoverPhyStats, setBasePhyStatsaddBehavior, addScript, behaviors, delAllBehaviors, delAllScripts, delBehavior, delScript, eachBehavior, eachScript, fetchBehavior, fetchBehavior, fetchScript, numBehaviors, numScripts, scriptscopyOf, initializeClass, newInstanceamDestroyed, destroy, isSavable, setSavablecanSaveDatabaseID, databaseID, setDatabaseIDdescription, displayText, image, isGeneric, L, maxRange, minRange, miscTextFormat, Name, rawImage, sameAs, setDescription, setDisplayText, setImage, setMiscText, setName, textexpirationDate, setExpirationDatebaseGoldValue, container, material, numberOfItems, owner, rawSecretIdentity, recursiveWeight, removeFromOwnerContainer, secretIdentity, setBaseValue, setContainer, setMaterial, setOwner, setSecretIdentity, setUsesRemaining, stopTicking, subjectToWearAndTear, ultimateContainer, usesRemaining, valuegetSaveStatIndex, getStat, getStatCodes, isStat, setStatexecuteMsgclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitdescription, displayText, nameisReadable, setReadableaffectCharState, affectCharStats, affectPhyStatsabilityImbuesMagic, addBehavior, addEffect, addNonUninvokableEffect, addScript, affectCharState, affectCharStats, affectPhyStats, alreadyWornMsg, amBeingWornProperly, amDestroyed, amWearingAt, baseGoldValue, basePhyStats, behaviors, canSaveDatabaseID, canWear, canWearComplete, cloneFix, compareProperLocations, compareTo, container, copyOf, databaseID, delAllBehaviors, delAllEffects, delAllScripts, delBehavior, delEffect, delScript, description, description, destroy, displayText, displayText, eachBehavior, eachEffect, eachScript, effects, executeMsg, expirationDate, fetchBehavior, fetchBehavior, fetchEffect, fetchEffect, fetchScript, fitsOn, getSaveStatIndex, getStat, getStatCodes, getTickStatus, I, image, initializeClass, isGeneric, isReadable, isSavable, isStat, L, material, maxRange, minRange, miscTextFormat, name, name, Name, newInstance, numBehaviors, numberOfItems, numEffects, numScripts, owner, phyStats, rawImage, rawLogicalAnd, rawProperLocationBitmap, rawSecretIdentity, rawWornCode, recoverPhyStats, recursiveWeight, removeFromOwnerContainer, riding, sameAs, scripts, secretIdentity, setBasePhyStats, setBaseValue, setContainer, setDatabaseID, setDescription, setDisplayText, setExpirationDate, setImage, setMaterial, setMiscText, setName, setOwner, setRawLogicalAnd, setRawProperLocationBitmap, setRawWornCode, setReadable, setRiding, setSavable, setSecretIdentity, setStat, setUsesRemaining, stopTicking, subjectToWearAndTear, tackOns, text, tick, ultimateContainer, unWear, usesRemaining, value, wearAt, wearEvenIfImpossible, wearIfPossible, wearIfPossible, whereCantWeargetTickStatus, name, tickamBeingWornProperly, amWearingAt, canWear, compareProperLocations, fitsOn, rawLogicalAnd, rawProperLocationBitmap, rawWornCode, setRawLogicalAnd, setRawProperLocationBitmap, setRawWornCode, unWear, wearAt, wearEvenIfImpossible, wearIfPossible, wearIfPossible, whereCantWearpublic java.lang.String ID()
CMObjectpublic java.lang.String genericName()
PhysicalgenericName in interface PhysicalgenericName in class StdItempublic java.lang.String readableText()
ReadablereadableText in interface ReadablereadableText in class StdItemReadable.isReadable(),
Readable.setReadable(boolean),
Readable.setReadableText(String)public void setReadableText(java.lang.String text)
ReadablesetReadableText in interface ReadablesetReadableText in class StdItemtext - the readable textReadable.isReadable(),
Readable.setReadable(boolean),
Readable.readableText()public int getUsedPages()
BookgetUsedPages in interface BookBook.getContent(int),
Book.getRawContent(int),
Book.getMaxPages()public int getMaxPages()
BookgetMaxPages in interface BookBook.setMaxPages(int),
Book.getUsedPages()public void setMaxPages(int max)
BooksetMaxPages in interface Bookmax - the maximum number of pages that can be written onBook.getMaxPages()public java.lang.String getRawContent(int page)
BookgetRawContent in interface Bookpage - the page number, 1-NBook.getContent(int),
Book.getUsedPages()public java.lang.String getContent(int page)
BookgetContent in interface Bookpage - the page number, 1-NBook.getRawContent(int),
Book.getUsedPages()public void addRawContent(java.lang.String authorName,
java.lang.String content)
BookaddRawContent in interface BookauthorName - the name of the author, which might not be usedcontent - the content, with subject surrounded by "::" as first chars, optionalBook.getRawContent(int),
Book.getUsedPages()public boolean isJournal()
Bookpublic int getMaxCharsPerPage()
BookgetMaxCharsPerPage in interface BookBook.setMaxCharsPerPage(int)public void setMaxCharsPerPage(int max)
BooksetMaxCharsPerPage in interface Bookmax - the maximum number of pages that can be written onBook.getMaxCharsPerPage()public boolean okMessage(Environmental myHost, CMMsg msg)
MsgListenerokMessage in interface MsgListenerokMessage in class StdItemmyHost - either the initiator of the event, or the host of this objectmsg - the CMMsg that wants to be executedCMMsg,
CMMsg.source()public boolean canRead(MOB mob)
Book