CGameJournal Class¶

The structure used for this class is CGameJournal

Quick Ref

void CGameJournal::CGameJournal()

void CGameJournal::~CGameJournal()

int CGameJournal::AddEntry(unsigned long strText, unsigned short nType)

int CGameJournal::AddEntry(unsigned long strText, int nChapter, long nTime, unsigned short nType)

void CGameJournal::AlphabetizeQuests(int nChapter)

void CGameJournal::ChangeEntry(unsigned long strRef, CString szNewText)

void CGameJournal::ChangeEntry(unsigned long nIndex, CString szNewText, int nChapter, unsigned char nCharacter)

void CGameJournal::ClearAllEntries()

unsigned short CGameJournal::CountEntries()

void CGameJournal::DeleteEntry(unsigned long strRef)

int CGameJournal::InsertEntryAfter(CString strText, unsigned long nEntry, unsigned short nType)

int CGameJournal::InsertEntryAfter(CString szText, unsigned long nIndex, int nChapter, long nTime, unsigned char nCharacter, unsigned short nType, unsigned long strRef)

void CGameJournal::Marshal(CSavedGameJournalEntry* pSavedEntry)

void CGameJournal::SetQuestDone(unsigned long strRef)

void CGameJournal::Unmarshal(CSavedGameJournalEntry* pSavedEntry, unsigned long nSavedEntry)

void CGameJournal::UpdateJournalEntry(unsigned long strText, long time, unsigned short type, int chapter, CString timeStamp)

Constructors¶

Name	Description
CGameJournal::CGameJournal	Constructs a `CGameJournal` object
CGameJournal::~CGameJournal	Destroys a `CGameJournal` object

CGameJournal::CGameJournal¶

Constructs a CGameJournal object

void CGameJournal::CGameJournal();

Remarks

Constructs a CGameJournal object

CGameJournal::~CGameJournal¶

Destroys the CGameJournal object

void CGameJournal::~CGameJournal();

Remarks

Destroys the CGameJournal object

Methods¶

Name	Description
CGameJournal::AddEntry	Add a journal entry
CGameJournal::AlphabetizeQuests	Sorts quests in the specified chapter in alphabetical order
CGameJournal::ChangeEntry	Change a journal entry
CGameJournal::ClearAllEntries	Clear all journal entries
CGameJournal::CountEntries	Returns count of all journal entries
CGameJournal::DeleteEntry	Delete a journal entry
CGameJournal::InsertEntryAfter	Insert a new journal entry after a specific journal entry
CGameJournal::Marshal
CGameJournal::SetQuestDone	Mark a journal quest entry as completed
CGameJournal::Unmarshal
CGameJournal::UpdateJournalEntry	Update a journal entry

CGameJournal::AddEntry¶

Add a journal entry

int CGameJournal::AddEntry(
   unsigned long strText,
   unsigned short nType);

Parameters

unsigned long strText - pointer to string containing text to add to journal
unsigned short nType - type of journal entry to add

Return Value

Returns an int value

Remarks

CGameJournal::AddEntry¶

Add a journal entry

int CGameJournal::AddEntry(
   unsigned long strText,
   int nChapter,
   long nTime,
   unsigned short nType);

Parameters

unsigned long strText - pointer to string containing text to add to journal
int nChapter - chapter to add journal entry to
long nTime - date time stamp for journal entry
unsigned short nType - type of journal entry to add

Return Value

Returns an int value

Remarks

CGameJournal::AlphabetizeQuests¶

Sorts quests in the specified chapter in alphabetical order

void CGameJournal::AlphabetizeQuests(int nChapter);

Parameters

int nChapter - chapter number to sort

Remarks

CGameJournal::ChangeEntry¶

Change a journal entry

void CGameJournal::ChangeEntry(
   unsigned long strRef,
   CString szNewText);

Parameters

unsigned long strRef - string reference
CString szNewText - string containing new text to use in journal entry

Remarks

CGameJournal::ChangeEntry¶

Change a journal entry

void CGameJournal::ChangeEntry(
   unsigned long nIndex,
   CString szNewText,
   int nChapter,
   unsigned char nCharacter);

Parameters

unsigned long nIndex - journal entry index id
CString szNewText - string containing new text to use in journal entry
int nChapter - chapter number that entry is located in
unsigned char nCharacter -

Remarks

CGameJournal::ClearAllEntries¶

Clear all journal entries

void CGameJournal::ClearAllEntries();

Remarks

CGameJournal::CountEntries¶

Returns count of all journal entries

unsigned short CGameJournal::CountEntries();

Return Value

Returns an unsigned short value which is the count of all journal entries

Remarks

CGameJournal::DeleteEntry¶

Delete a journal entry

void CGameJournal::DeleteEntry(unsigned long strRef);

Parameters

unsigned long strRef - string reference of journal entry to delete

Remarks

CGameJournal::InsertEntryAfter¶

Insert a new journal entry after a specific journal entry

int CGameJournal::InsertEntryAfter(
   :ref:`CString<CString>` strText,
   unsigned long nEntry,
   unsigned short nType);

Parameters

CString strText - string containing new text to use in journal entry
unsigned long nEntry - journal entry id to insert new entry after
unsigned short nType - type of journal entry to add

Return Value

Returns an int value

Remarks

CGameJournal::InsertEntryAfter¶

Insert a new journal entry after a specific journal entry

int CGameJournal::InsertEntryAfter(
   CString szText,
   unsigned long nIndex,
   int nChapter,
   long nTime,
   unsigned char nCharacter,
   unsigned short nType,
   unsigned long strRef);

Parameters

CString szText - string containing new text to use in journal entry
unsigned long nIndex - journal entry id to insert new entry after
int nChapter - chapter to add journal entry to
long nTime - date time stamp for journal entry
unsigned char nCharacter -
unsigned short nType - type of journal entry to add
unsigned long strRef - string reference

Return Value

Returns an int value

Remarks

CGameJournal::Marshal¶

void CGameJournal::Marshal(CSavedGameJournalEntry* pSavedEntry);

Parameters

CSavedGameJournalEntry* pSavedEntry -

Remarks

CGameJournal::SetQuestDone¶

Mark a journal quest entry as completed

void CGameJournal::SetQuestDone(unsigned long strRef);

Parameters

unsigned long strRef - string reference of journal entry to mark as completed

Remarks

CGameJournal::Unmarshal¶

void CGameJournal::Unmarshal(
   CSavedGameJournalEntry* pSavedEntry,
   unsigned long nSavedEntry);

Parameters

CSavedGameJournalEntry* pSavedEntry -
unsigned long nSavedEntry -

Remarks

CGameJournal::UpdateJournalEntry¶

Update a journal entry

void CGameJournal::UpdateJournalEntry(
   unsigned long strText,
   long time,
   unsigned short type,
   int chapter,
   CString timeStamp);

Parameters

unsigned long strText - string containing journal entry text
long time - date time stamp for journal entry
unsigned short type - type of journal entry
int chapter - chapter number
CString timeStamp - date time stamp text

Remarks