OpenMW: MWDialogue::Journal Class Reference

The player's journal. More...

#include <journalimp.hpp>

Inheritance diagram for MWDialogue::Journal:

Collaboration diagram for MWDialogue::Journal:

Public Member Functions
	Journal ()

virtual void	clear ()

virtual void	addEntry (const std::string &id, int index, const MWWorld::Ptr &actor)

virtual void	setJournalIndex (const std::string &id, int index)
	Set the journal index without adding an entry. More...

virtual int	getJournalIndex (const std::string &id) const
	Get the journal index. More...

virtual void	addTopic (const std::string &topicId, const std::string &infoId, const MWWorld::Ptr &actor)

virtual void	removeLastAddedTopicResponse (const std::string &topicId, const std::string &actorName)

virtual TEntryIter	begin () const

virtual TEntryIter	end () const
	Iterator pointing past the end of the main journal. More...

virtual TQuestIter	questBegin () const
	Iterator pointing to the first quest (sorted by topic ID) More...

virtual TQuestIter	questEnd () const
	Iterator pointing past the last quest. More...

virtual TTopicIter	topicBegin () const

virtual TTopicIter	topicEnd () const
	Iterator pointing past the last topic. More...

virtual int	countSavedGameRecords () const

virtual void	write (ESM::ESMWriter &writer, Loading::Listener &progress) const

virtual void	readRecord (ESM::ESMReader &reader, uint32_t type)

Public Member Functions inherited from MWBase::Journal
	Journal ()

virtual	~Journal ()

Private Member Functions
Quest &	getQuest (const std::string &id)

Topic &	getTopic (const std::string &id)

bool	isThere (const std::string &topicId, const std::string &infoId="") const

Private Attributes
TEntryContainer	mJournal

TQuestContainer	mQuests

TTopicContainer	mTopics

Additional Inherited Members
Public Types inherited from MWBase::Journal
typedef std::deque < MWDialogue::StampedJournalEntry >	TEntryContainer

typedef TEntryContainer::const_iterator	TEntryIter

typedef std::map< std::string, MWDialogue::Quest >	TQuestContainer

typedef TQuestContainer::const_iterator	TQuestIter

typedef std::map< std::string, MWDialogue::Topic >	TTopicContainer

typedef TTopicContainer::const_iterator	TTopicIter

Detailed Description

The player's journal.

Constructor & Destructor Documentation

MWDialogue::Journal::Journal ( )

Member Function Documentation

void MWDialogue::Journal::addEntry	(	const std::string &	id,
		int	index,
		const MWWorld::Ptr &	actor
	)

virtual

Add a journal entry.

Parameters

actor Used as context for replacing of escape sequences (name, etc).

Implements MWBase::Journal.

Here is the call graph for this function:

void MWDialogue::Journal::addTopic	(	const std::string &	topicId,
		const std::string &	infoId,
		const MWWorld::Ptr &	actor
	)

virtual

Implements MWBase::Journal.

Here is the call graph for this function:

Journal::TEntryIter MWDialogue::Journal::begin ( ) const

virtual

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.

int MWDialogue::Journal::countSavedGameRecords ( ) const

virtual

Implements MWBase::Journal.

Here is the call graph for this function:

Journal::TEntryIter MWDialogue::Journal::end ( ) const

virtual

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.

Here is the caller graph for this function:

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

private

Here is the caller graph for this function:

Topic & MWDialogue::Journal::getTopic ( const std::string & id )

private

Here is the caller graph for this function:

bool MWDialogue::Journal::isThere	(	const std::string &	topicId,
		const std::string &	infoId = `""`
	)		const

private

Here is the call graph for this function:

Here is the caller graph for this function:

Journal::TQuestIter MWDialogue::Journal::questBegin ( ) const

virtual

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

Implements MWBase::Journal.

Journal::TQuestIter MWDialogue::Journal::questEnd ( ) const

virtual

Iterator pointing past the last quest.

Implements MWBase::Journal.

void MWDialogue::Journal::readRecord	(	ESM::ESMReader &	reader,
		uint32_t	type
	)

virtual

Implements MWBase::Journal.

Here is the call graph for this function:

void MWDialogue::Journal::removeLastAddedTopicResponse	(	const std::string &	topicId,
		const std::string &	actorName
	)

virtual

Note: topicId must be lowercase Removes the last topic response added for the given topicId and actor name.; topicId must be lowercase

Implements MWBase::Journal.

Here is the call graph for this function:

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

virtual

Set the journal index without adding an entry.

Implements MWBase::Journal.

Here is the call graph for this function:

Journal::TTopicIter MWDialogue::Journal::topicBegin ( ) const

virtual

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.

Journal::TTopicIter MWDialogue::Journal::topicEnd ( ) const

virtual

Iterator pointing past the last topic.

Implements MWBase::Journal.

void MWDialogue::Journal::write	(	ESM::ESMWriter &	writer,
		Loading::Listener &	progress
	)		const

virtual

Implements MWBase::Journal.

Here is the call graph for this function:

Member Data Documentation

TEntryContainer MWDialogue::Journal::mJournal

private

TQuestContainer MWDialogue::Journal::mQuests

private

TTopicContainer MWDialogue::Journal::mTopics

private

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

/home/travis/build/OpenMW/openmw/apps/openmw/mwdialogue/journalimp.hpp
/home/travis/build/OpenMW/openmw/apps/openmw/mwdialogue/journalimp.cpp