You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
101 lines
3.3 KiB
C++
101 lines
3.3 KiB
C++
#ifndef GAME_MWBASE_JOURNAL_H
|
|
#define GAME_MWBASE_JOURNAL_H
|
|
|
|
#include <string>
|
|
#include <deque>
|
|
#include <map>
|
|
|
|
#include <stdint.h>
|
|
|
|
#include "../mwdialogue/journalentry.hpp"
|
|
#include "../mwdialogue/topic.hpp"
|
|
#include "../mwdialogue/quest.hpp"
|
|
|
|
namespace Loading
|
|
{
|
|
class Listener;
|
|
}
|
|
|
|
namespace ESM
|
|
{
|
|
class ESMReader;
|
|
class ESMWriter;
|
|
}
|
|
|
|
namespace MWBase
|
|
{
|
|
/// \brief Interface for the player's journal (implemented in MWDialogue)
|
|
class Journal
|
|
{
|
|
Journal (const Journal&);
|
|
///< not implemented
|
|
|
|
Journal& operator= (const Journal&);
|
|
///< not implemented
|
|
|
|
public:
|
|
|
|
typedef std::deque<MWDialogue::StampedJournalEntry> TEntryContainer;
|
|
typedef TEntryContainer::const_iterator TEntryIter;
|
|
typedef std::map<std::string, MWDialogue::Quest> TQuestContainer; // topic, quest
|
|
typedef TQuestContainer::const_iterator TQuestIter;
|
|
typedef std::map<std::string, MWDialogue::Topic> TTopicContainer; // topic-id, topic-content
|
|
typedef TTopicContainer::const_iterator TTopicIter;
|
|
|
|
public:
|
|
|
|
Journal() {}
|
|
|
|
virtual void clear() = 0;
|
|
|
|
virtual ~Journal() {}
|
|
|
|
virtual void addEntry (const std::string& id, int index, const MWWorld::Ptr& actor) = 0;
|
|
///< Add a journal entry.
|
|
/// @param actor Used as context for replacing of escape sequences (%name, etc).
|
|
|
|
virtual void setJournalIndex (const std::string& id, int index) = 0;
|
|
///< Set the journal index without adding an entry.
|
|
|
|
virtual int getJournalIndex (const std::string& id) const = 0;
|
|
///< Get the journal index.
|
|
|
|
virtual void addTopic (const std::string& topicId, const std::string& infoId, const MWWorld::Ptr& actor) = 0;
|
|
/// \note topicId must be lowercase
|
|
|
|
virtual void removeLastAddedTopicResponse (const std::string& topicId, const std::string& actorName) = 0;
|
|
///< Removes the last topic response added for the given topicId and actor name.
|
|
/// \note topicId must be lowercase
|
|
|
|
virtual TEntryIter begin() const = 0;
|
|
///< Iterator pointing to the begin of the main journal.
|
|
///
|
|
/// \note Iterators to main journal entries will never become invalid.
|
|
|
|
virtual TEntryIter end() const = 0;
|
|
///< Iterator pointing past the end of the main journal.
|
|
|
|
virtual TQuestIter questBegin() const = 0;
|
|
///< Iterator pointing to the first quest (sorted by topic ID)
|
|
|
|
virtual TQuestIter questEnd() const = 0;
|
|
///< Iterator pointing past the last quest.
|
|
|
|
virtual TTopicIter topicBegin() const = 0;
|
|
///< Iterator pointing to the first topic (sorted by topic ID)
|
|
///
|
|
/// \note The topic ID is identical with the user-visible topic string.
|
|
|
|
virtual TTopicIter topicEnd() const = 0;
|
|
///< Iterator pointing past the last topic.
|
|
|
|
virtual int countSavedGameRecords() const = 0;
|
|
|
|
virtual void write (ESM::ESMWriter& writer, Loading::Listener& progress) const = 0;
|
|
|
|
virtual void readRecord (ESM::ESMReader& reader, uint32_t type) = 0;
|
|
};
|
|
}
|
|
|
|
#endif
|