ResidualVM logo ResidualVM website - Forums - Contact us BuildBot - Doxygen - Wiki curved edge

Speech resource. More...

#include <speech.h>

Inheritance diagram for Stark::Resources::Speech:
Collaboration diagram for Stark::Resources::Speech:

List of all members.

Public Member Functions

 Speech (Object *parent, byte subType, uint16 index, const Common::String &name)
virtual ~Speech ()
void readData (Formats::XRCReadStream *stream) override
 Deserialize the resource static data and initial state.
void onGameLoop () override
 Called once per game loop.
void onExitLocation () override
 Called when exiting a location.
void onPreDestroy () override
 Called before a resource sub-tree is unloaded.
void saveLoadCurrent (ResourceSerializer *serializer) override
 Persist / restore the resource state.
Common::String getPhrase () const
 Obtain the text associated to the speech line.
void playSound ()
 Play the voice over.
bool isPlaying ()
 Return true if the speech is playing.
void stop ()
 Stop the speech if it is playing.
bool characterIsApril () const
 Is the character saying the line April ?
void setPlayTalkAnim (bool playTalkAnim)
 Should the character change to the talk anim while this is playing?
int32 getCharacterId ()
 Get the character's id - index in the KnowledgeSet.

Static Public Attributes

static const Type::ResourceType TYPE = Type::kSpeech

Protected Member Functions

void printData () override
void setCharacterTalkAnim ()
void removeCharacterTalkAnim () const
ItemVisualgetCharacterItem () const
void stopOtherSpeechesFromSameCharacter ()

Protected Attributes

Common::String _phrase
int32 _character
bool _playTalkAnim
bool _removeTalkAnimWhenComplete
Sound_soundResource
LipSync_lipSync

Detailed Description

Speech resource.

Speech resources are used to define dialog lines. A Speech resource contains text for a character and references a Sound resource for the dubbing.

Definition at line 49 of file speech.h.


Constructor & Destructor Documentation

Stark::Resources::Speech::Speech ( Object parent,
byte  subType,
uint16  index,
const Common::String name 
)

Definition at line 45 of file speech.cpp.

Stark::Resources::Speech::~Speech (  )  [virtual]

Definition at line 42 of file speech.cpp.


Member Function Documentation

bool Stark::Resources::Speech::characterIsApril (  )  const

Is the character saying the line April ?

Definition at line 131 of file speech.cpp.

int32 Stark::Resources::Speech::getCharacterId (  ) 

Get the character's id - index in the KnowledgeSet.

Definition at line 105 of file speech.cpp.

ItemVisual * Stark::Resources::Speech::getCharacterItem (  )  const [protected]

Definition at line 91 of file speech.cpp.

Common::String Stark::Resources::Speech::getPhrase (  )  const

Obtain the text associated to the speech line.

Definition at line 55 of file speech.cpp.

bool Stark::Resources::Speech::isPlaying (  ) 

Return true if the speech is playing.

Definition at line 109 of file speech.cpp.

void Stark::Resources::Speech::onExitLocation (  )  [override, virtual]

Called when exiting a location.

Reimplemented from Stark::Resources::Object.

Definition at line 154 of file speech.cpp.

void Stark::Resources::Speech::onGameLoop (  )  [override, virtual]

Called once per game loop.

Reimplemented from Stark::Resources::Object.

Definition at line 143 of file speech.cpp.

void Stark::Resources::Speech::onPreDestroy (  )  [override, virtual]

Called before a resource sub-tree is unloaded.

Reimplemented from Stark::Resources::Object.

Definition at line 158 of file speech.cpp.

void Stark::Resources::Speech::playSound (  ) 

Play the voice over.

Definition at line 59 of file speech.cpp.

void Stark::Resources::Speech::printData (  )  [override, protected, virtual]

Reimplemented from Stark::Resources::Object.

Definition at line 162 of file speech.cpp.

void Stark::Resources::Speech::readData ( Formats::XRCReadStream stream  )  [override, virtual]

Deserialize the resource static data and initial state.

Reimplemented from Stark::Resources::Object.

Definition at line 136 of file speech.cpp.

void Stark::Resources::Speech::removeCharacterTalkAnim (  )  const [protected]

Definition at line 84 of file speech.cpp.

void Stark::Resources::Speech::saveLoadCurrent ( ResourceSerializer serializer  )  [override, virtual]

Persist / restore the resource state.

Called only for active locations

Reimplemented from Stark::Resources::Object.

Definition at line 195 of file speech.cpp.

void Stark::Resources::Speech::setCharacterTalkAnim (  )  [protected]

Definition at line 72 of file speech.cpp.

void Stark::Resources::Speech::setPlayTalkAnim ( bool  playTalkAnim  ) 

Should the character change to the talk anim while this is playing?

Definition at line 169 of file speech.cpp.

void Stark::Resources::Speech::stop (  ) 

Stop the speech if it is playing.

Definition at line 113 of file speech.cpp.

void Stark::Resources::Speech::stopOtherSpeechesFromSameCharacter (  )  [protected]

Definition at line 173 of file speech.cpp.


Member Data Documentation

Definition at line 94 of file speech.h.

Definition at line 99 of file speech.h.

Definition at line 93 of file speech.h.

Definition at line 95 of file speech.h.

Definition at line 96 of file speech.h.

Definition at line 98 of file speech.h.

const Type::ResourceType Stark::Resources::Speech::TYPE = Type::kSpeech [static]

Definition at line 51 of file speech.h.


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


Generated on Sat Jan 19 2019 05:07:58 for ResidualVM by doxygen 1.7.1
curved edge   curved edge