Affectable
, Behavable
, java.lang.Cloneable
, CMObject
, java.lang.Comparable<CMObject>
, Contingent
, DBIdentifiable
, Environmental
, Expireable
, Item
, Modifiable
, MsgListener
, Physical
, PhysicalAgent
, Readable
, Rider
, StatsAffecting
, Tickable
, Wearable
ArchonJournal
, GenBook
, GenJournal
, GenPaper
, GenPlayerBook
, StdBook
, StdJournal
, StdPaper
, StdPlayerBook
public interface Book extends Item
Wearable.CODES
idConverter
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
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
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 |
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.
|
boolean |
isJournal() |
Returns whether the content is shared among all similar items, or
is unique to this item or owner or a special key.
|
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.
|
addEffect, addNonUninvokableEffect, basePhyStats, delAllEffects, delEffect, eachEffect, effects, fetchEffect, fetchEffect, numEffects, phyStats, recoverPhyStats, setBasePhyStats
addBehavior, addScript, behaviors, delAllBehaviors, delAllScripts, delBehavior, delScript, eachBehavior, eachScript, fetchBehavior, fetchBehavior, fetchScript, numBehaviors, numScripts, scripts
copyOf, ID, initializeClass, newInstance
amDestroyed, destroy, isSavable, setSavable
canSaveDatabaseID, databaseID, setDatabaseID
description, displayText, image, isGeneric, L, maxRange, minRange, miscTextFormat, Name, rawImage, sameAs, setDescription, setDisplayText, setImage, setMiscText, setName, text
expirationDate, setExpirationDate
baseGoldValue, container, material, numberOfItems, owner, rawSecretIdentity, recursiveWeight, removeFromOwnerContainer, secretIdentity, setBaseValue, setContainer, setMaterial, setOwner, setSecretIdentity, setUsesRemaining, stopTicking, subjectToWearAndTear, ultimateContainer, usesRemaining, value
getSaveStatIndex, getStat, getStatCodes, isStat, setStat
executeMsg, okMessage
description, displayText, genericName, name
isReadable, readableText, setReadable, setReadableText
affectCharState, affectCharStats, affectPhyStats
getTickStatus, name, tick
amBeingWornProperly, amWearingAt, canWear, compareProperLocations, fitsOn, rawLogicalAnd, rawProperLocationBitmap, rawWornCode, setRawLogicalAnd, setRawProperLocationBitmap, setRawWornCode, unWear, wearAt, wearEvenIfImpossible, wearIfPossible, wearIfPossible, whereCantWear
int getUsedPages()
getContent(int)
,
getRawContent(int)
,
getMaxPages()
int getMaxPages()
setMaxPages(int)
,
getUsedPages()
void setMaxPages(int max)
max
- the maximum number of pages that can be written ongetMaxPages()
int getMaxCharsPerPage()
setMaxCharsPerPage(int)
void setMaxCharsPerPage(int max)
max
- the maximum number of pages that can be written ongetMaxCharsPerPage()
java.lang.String getRawContent(int page)
page
- the page number, 1-NgetContent(int)
,
getUsedPages()
java.lang.String getContent(int page)
page
- the page number, 1-NgetRawContent(int)
,
getUsedPages()
void addRawContent(java.lang.String authorName, java.lang.String content)
authorName
- the name of the author, which might not be usedcontent
- the content, with subject surrounded by "::" as first chars, optionalgetRawContent(int)
,
getUsedPages()
boolean isJournal()
boolean canRead(MOB mob)
mob
- the mob/player to checkboolean canWrite(MOB mob)
mob
- the mob/player to check