com.planet_ink.coffee_mud.Items.interfaces
Interface Book

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 Implementing Classes:

ArchonJournal, GenBook, GenJournal, GenPaper, GenPlayerBook, StdBook, StdJournal, StdPaper, StdPlayerBook

public interface Book
extends Item

A book is a readable object that can usually be written to.

Nested Class Summary

Nested classes/interfaces inherited from interface com.planet_ink.coffee_mud.Items.interfaces.Wearable

Wearable.CODES

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

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

Method Summary

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

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

riding, setRiding

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

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.core.interfaces.DBIdentifiable

canSaveDatabaseID, databaseID, setDatabaseID

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

Methods inherited from interface com.planet_ink.coffee_mud.core.interfaces.Readable

isReadable, readableText, setReadable, setReadableText

Method Detail

getUsedPages

int getUsedPages()

Returns the number of pages with writing on them.

Returns:

the number of pages with writing on them.

See Also:

getContent(int), getRawContent(int), getMaxPages()

getMaxPages

int getMaxPages()

Returns the maximum number of pages that can be written on in this book. 0 means infinite.

Returns:

the maximum number of pages that can be written on

See Also:

setMaxPages(int), getUsedPages()

setMaxPages

void setMaxPages(int max)

Sets the maximum number of pages that can be written on in this book. 0 means infinite.

Parameters:

max - the maximum number of pages that can be written on

See Also:

getMaxPages()

getMaxCharsPerPage

int getMaxCharsPerPage()

Returns the maximum number of chars that can be written on each page in this book. 0 means infinite.

Returns:

the maximum number of chars that can be written on

See Also:

setMaxCharsPerPage(int)

setMaxCharsPerPage

void setMaxCharsPerPage(int max)

Sets the maximum number of chars that can be written on each page in this book. 0 means infinite.

Parameters:

max - the maximum number of pages that can be written on

See Also:

getMaxCharsPerPage()

getRawContent

java.lang.String getRawContent(int page)

Returns the raw content of a page

Parameters:

page - the page number, 1-N

Returns:

the raw content of a page

See Also:

getContent(int), getUsedPages()

getContent

java.lang.String getContent(int page)

Returns the readable content of a page

Parameters:

page - the page number, 1-N

Returns:

the readable content of a page

See Also:

getRawContent(int), getUsedPages()

addRawContent

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.

Parameters:

authorName - the name of the author, which might not be used

content - the content, with subject surrounded by "::" as first chars, optional

See Also:

getRawContent(int), getUsedPages()

isJournal

boolean isJournal()

Returns whether the content is shared among all similar items, or is unique to this item or owner or a special key.

Returns:

true if it is shared, false otherwise