Stark::Diary Class Reference

#include <diary.h>

Classes
struct	ConversationLog
struct	ConversationLogLine

Public Member Functions
bool	isEnabled () const
bool	hasUnreadEntries () const
void	setDiaryAllRead ()
void	addDiaryEntry (const Common::String &name)
uint32	getPageIndex () const
void	setPageIndex (uint32 pageIndex)
void	addFMVEntry (const Common::Path &filename, const Common::String &title, int gameDisc)
uint	countFMV () const
const Common::Path &	getFMVFilename (uint index) const
const Common::String &	getFMVTitle (uint index) const
uint	countDiary () const
const Common::String &	getDiary (uint index) const
uint	countDialog () const
const ConversationLog &	getDialog (uint index) const
void	openDialog (const Common::String &title, const Common::String &characterName, int32 characterId)
void	logSpeech (const Common::String &line, int32 characterId)
void	closeDialog ()
void	clear ()
void	readStateFromStream (Common::SeekableReadStream *stream, uint32 version)
void	writeStateToStream (Common::WriteStream *stream)

Detailed Description

Diary state storage

Stores references to all the unlocked data available from the diary menu

Member Function Documentation

isEnabled()

bool Stark::Diary::isEnabled

(

)

const

Does the player have the diary in their inventory?

hasUnreadEntries()

bool Stark::Diary::hasUnreadEntries

(

)

const

Does the diary contain entries that have not been read yet?

setDiaryAllRead()

void Stark::Diary::setDiaryAllRead ( )

inline

Mark all the diary entries read

addDiaryEntry()

void Stark::Diary::addDiaryEntry

(

const Common::String &

name

)

Add an entry to the list of available diary pages

getPageIndex()

uint32 Stark::Diary::getPageIndex ( ) const

inline

Get and set the current diary page index

addFMVEntry()

void Stark::Diary::addFMVEntry	(	const Common::Path &	filename,
		const Common::String &	title,
		int	gameDisc
	)

Add a FMV entry to the list of movies available to play from the diary

countFMV()

uint Stark::Diary::countFMV ( ) const

inline

Get info of added FMV entries

countDiary()

uint Stark::Diary::countDiary ( ) const

inline

Get info of added Diary entries

countDialog()

uint Stark::Diary::countDialog ( ) const

inline

Get added Dialog entries

openDialog()

void Stark::Diary::openDialog	(	const Common::String &	title,
		const Common::String &	characterName,
		int32	characterId
	)

Start recording speech lines for a dialog

logSpeech()

void Stark::Diary::logSpeech	(	const Common::String &	line,
		int32	characterId
	)

Record a speech line for the previously opened dialog

closeDialog()

void Stark::Diary::closeDialog

(

)

Close the currently active dialog

clear()

void Stark::Diary::clear

(

)

Reset all the game state data

readStateFromStream()

void Stark::Diary::readStateFromStream	(	Common::SeekableReadStream *	stream,
		uint32	version
	)

Replace the current state by that read from the stream

writeStateToStream()

void Stark::Diary::writeStateToStream

(

Common::WriteStream *

stream

)

Write the state to a stream

---

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

• engines/stark/services/diary.h