OpenMW
Public Member Functions | Private Member Functions | Private Attributes
MWDialogue::Journal Class Reference

The player's journal. More...

#include <journalimp.hpp>

List of all members.

Public Member Functions

 Journal ()
virtual void clear ()
virtual void addEntry (const std::string &id, int index)
 Add a journal entry.
virtual void setJournalIndex (const std::string &id, int index)
 Set the journal index without adding an entry.
virtual int getJournalIndex (const std::string &id) const
 Get the journal index.
virtual void addTopic (const std::string &topicId, const std::string &infoId)
virtual TEntryIter begin () const
virtual TEntryIter end () const
 Iterator pointing past the end of the main journal.
virtual TQuestIter questBegin () const
 Iterator pointing to the first quest (sorted by topic ID)
virtual TQuestIter questEnd () const
 Iterator pointing past the last quest.
virtual TTopicIter topicBegin () const
virtual TTopicIter topicEnd () const
 Iterator pointing past the last topic.

Private Member Functions

QuestgetQuest (const std::string &id)

Private Attributes

TEntryContainer mJournal
TQuestContainer mQuests
TTopicContainer mTopics

Detailed Description

The player's journal.


Constructor & Destructor Documentation

Reimplemented from MWBase::Journal.


Member Function Documentation

void MWDialogue::Journal::addEntry ( const std::string &  id,
int  index 
) [virtual]

Add a journal entry.

Implements MWBase::Journal.

void MWDialogue::Journal::addTopic ( const std::string &  topicId,
const std::string &  infoId 
) [virtual]

Implements MWBase::Journal.

Iterator pointing to the begin of the main journal.

Note:
Iterators to main journal entries will never become invalid.

Implements MWBase::Journal.

void MWDialogue::Journal::clear ( ) [virtual]

Implements MWBase::Journal.

Iterator pointing past the end of the main journal.

Implements MWBase::Journal.

int MWDialogue::Journal::getJournalIndex ( const std::string &  id) const [virtual]

Get the journal index.

Implements MWBase::Journal.

Quest & MWDialogue::Journal::getQuest ( const std::string &  id) [private]

Iterator pointing to the first quest (sorted by topic ID)

Implements MWBase::Journal.

Iterator pointing past the last quest.

Implements MWBase::Journal.

void MWDialogue::Journal::setJournalIndex ( const std::string &  id,
int  index 
) [virtual]

Set the journal index without adding an entry.

Implements MWBase::Journal.

Iterator pointing to the first topic (sorted by topic ID)

Note:
The topic ID is identical with the user-visible topic string.

Implements MWBase::Journal.

Iterator pointing past the last topic.

Implements MWBase::Journal.


Member Data Documentation


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