ScummVM API documentation
Stark::Resources::Dialog Class Reference

#include <dialog.h>

Inheritance diagram for Stark::Resources::Dialog:
Stark::Resources::Object

Classes

class  Reply
 
class  Topic
 

Public Types

typedef Common::Array< Topic * > TopicArray
 

Public Member Functions

 Dialog (Object *parent, byte subType, uint16 index, const Common::String &name)
 
void readData (Formats::XRCReadStream *stream) override
 
void saveLoad (ResourceSerializer *serializer) override
 
TopicArray listAvailableTopics ()
 
DialoggetNextDialog (Reply *reply)
 
ScriptgetNextScript (Reply *reply)
 
Common::String getDiaryTitle () const
 
int32 getCharacter () const
 
void printData () override
 
- Public Member Functions inherited from Stark::Resources::Object
Type getType () const
 
byte getSubType () const
 
uint16 getIndex () const
 
Common::String getIndexAsString () const
 
Common::String getName () const
 
virtual void saveLoadCurrent (ResourceSerializer *serializer)
 
virtual void onPostRead ()
 
virtual void onAllLoaded ()
 
virtual void onEnterLocation ()
 
virtual void onGameLoop ()
 
virtual void onEnginePause (bool pause)
 
virtual void onExitLocation ()
 
virtual void onPreDestroy ()
 
template<class T >
T * findParent ()
 
ObjectfindChildWithIndex (Type type, uint16 index, int subType=-1) const
 
ObjectfindChildWithOrder (Type type, uint16 order, int subType=-1) const
 
ObjectfindChildWithName (Type type, const Common::String &name, int subType=-1) const
 
template<class T >
T * findChild (bool mustBeUnique=true) const
 
template<class T >
T * findChildWithSubtype (int subType, bool mustBeUnique=true) const
 
template<class T >
T * findChildWithIndex (uint16 index, int subType=-1) const
 
template<class T >
T * findChildWithOrder (uint16 order, int subType=-1) const
 
template<class T >
T * findChildWithName (const Common::String &name, int subType=-1) const
 
template<class T >
Common::Array< T * > listChildren (int subType=-1) const
 
template<class T >
Common::Array< T * > listChildrenRecursive (int subType=-1)
 
void addChild (Object *child)
 
virtual void print (uint depth=0)
 
template<>
Objectcast (Object *resource)
 
template<>
ObjectfindParent ()
 
template<>
Common::Array< Object * > listChildren (int subType) const
 

Public Attributes

Common::Array< Topic_topics
 
uint32 _character
 
uint32 _hasAskAbout
 

Static Public Attributes

static const Type::ResourceType TYPE = Type::kDialog
 

Additional Inherited Members

- Static Public Member Functions inherited from Stark::Resources::Object
template<class T >
static T * cast (Object *resource)
 
- Protected Member Functions inherited from Stark::Resources::Object
 Object (Object *parent, byte subType, uint16 index, const Common::String &name)
 
void printWithDepth (uint depth, const Common::String &string) const
 
void printDescription (uint depth) const
 
- Protected Attributes inherited from Stark::Resources::Object
Type _type
 
byte _subType
 
uint16 _index
 
Common::String _name
 
Object_parent
 
Common::Array< Object * > _children
 

Detailed Description

A dialog between two characters.

Dialogs are made of a list of topics. Each topic has a list of possible answers, one of which is played when the player selects the topic, until all the possible answers have been played.

Answers are made of a list of lines. All of the lines of an answer are played, one after the other when an answer is played. Lines reference Speech resources.

Member Function Documentation

◆ readData()

void Stark::Resources::Dialog::readData ( Formats::XRCReadStream stream)
overridevirtual

Deserialize the resource static data and initial state.

Reimplemented from Stark::Resources::Object.

◆ saveLoad()

void Stark::Resources::Dialog::saveLoad ( ResourceSerializer serializer)
overridevirtual

Persist / restore the resource state

Reimplemented from Stark::Resources::Object.

◆ listAvailableTopics()

TopicArray Stark::Resources::Dialog::listAvailableTopics ( )

List the currently available topics for this Dialog

◆ getNextDialog()

Dialog* Stark::Resources::Dialog::getNextDialog ( Reply reply)

Obtain the Dialog which should be played at the outcome of this one, if any

◆ getNextScript()

Script* Stark::Resources::Dialog::getNextScript ( Reply reply)

Obtain the Script which should be executed after this dialog, if any

◆ getDiaryTitle()

Common::String Stark::Resources::Dialog::getDiaryTitle ( ) const

Get the dialog's title as shown in the diary

◆ getCharacter()

int32 Stark::Resources::Dialog::getCharacter ( ) const

Get the character's id - index in the KnowledgeSet


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