ScummVM API documentation
Sherlock::Journal Class Referenceabstract
Inheritance diagram for Sherlock::Journal:
Sherlock::Scalpel::ScalpelJournal Sherlock::Tattoo::TattooJournal

Public Member Functions

bool drawJournal (int direction, int howFar)
 
void synchronize (Serializer &s)
 
virtual void drawFrame ()=0
 
virtual void resetPosition ()
 
virtual void record (int converseNum, int statementNum, bool replyOnly=false)
 

Static Public Member Functions

static Journalinit (SherlockEngine *vm)
 

Protected Member Functions

 Journal (SherlockEngine *vm)
 
void loadJournalFile (bool alreadyLoaded)
 
bool isPrintable (byte ch) const
 

Protected Attributes

SherlockEngine_vm
 
Common::StringArray _directory
 
Common::StringArray _locations
 
Common::Array< JournalEntry_journal
 
Common::StringArray _lines
 
bool _up
 
bool _down
 
int _index
 
int _page
 
int _maxPage
 
int _sub
 
Common::String _find
 

Member Function Documentation

◆ loadJournalFile()

void Sherlock::Journal::loadJournalFile ( bool  alreadyLoaded)
protected

Loads the description for the current display index in the journal, and then word wraps the result to prepare it for being displayed

Parameters
alreadyLoadedIndicates whether the journal file is being loaded for the first time, or being reloaded

◆ isPrintable()

bool Sherlock::Journal::isPrintable ( byte  ch) const
protected

Returns true if a given character is printable

◆ drawJournal()

bool Sherlock::Journal::drawJournal ( int  direction,
int  howFar 
)

Displays a page of the journal at the current index

◆ synchronize()

void Sherlock::Journal::synchronize ( Serializer s)

Synchronize the data for a savegame

◆ drawFrame()

virtual void Sherlock::Journal::drawFrame ( )
pure virtual

Draw the journal background, frame, and interface buttons

Implemented in Sherlock::Scalpel::ScalpelJournal, and Sherlock::Tattoo::TattooJournal.

◆ resetPosition()

virtual void Sherlock::Journal::resetPosition ( )
inlinevirtual

Reset viewing position to the start of the journal

Reimplemented in Sherlock::Scalpel::ScalpelJournal.

◆ record()

virtual void Sherlock::Journal::record ( int  converseNum,
int  statementNum,
bool  replyOnly = false 
)
virtual

Records statements that are said, in the order which they are said. The player can then read the journal to review them

Reimplemented in Sherlock::Scalpel::ScalpelJournal, and Sherlock::Tattoo::TattooJournal.


The documentation for this class was generated from the following file: