ScummVM API documentation
Public Member Functions | Static Public Attributes | Protected Member Functions | Protected Attributes | List of all members
Stark::Resources::Speech Class Reference

#include <speech.h>

Inheritance diagram for Stark::Resources::Speech:
Stark::Resources::Object

Public Member Functions

 Speech (Object *parent, byte subType, uint16 index, const Common::String &name)
 
void readData (Formats::XRCReadStream *stream) override
 
void onGameLoop () override
 
void onExitLocation () override
 
void onPreDestroy () override
 
void saveLoadCurrent (ResourceSerializer *serializer) override
 
Common::String getPhrase () const
 
void playSound ()
 
bool isPlaying ()
 
void stop ()
 
bool characterIsApril () const
 
void setPlayTalkAnim (bool playTalkAnim)
 
int32 getCharacterId ()
 
- 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 saveLoad (ResourceSerializer *serializer)
 
virtual void onPostRead ()
 
virtual void onAllLoaded ()
 
virtual void onEnterLocation ()
 
virtual void onEnginePause (bool pause)
 
template<class T >
T * findParent ()
 
Object * findChildWithIndex (Type type, uint16 index, int subType=-1) const
 
Object * findChildWithOrder (Type type, uint16 order, int subType=-1) const
 
Object * findChildWithName (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<>
Object * cast (Object *resource)
 
template<>
Object * findParent ()
 
template<>
Common::Array< Object * > listChildren (int subType) const
 

Static Public Attributes

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

Protected Member Functions

void printData () override
 
void setCharacterTalkAnim ()
 
void removeCharacterTalkAnim () const
 
ItemVisual * getCharacterItem () const
 
void stopOtherSpeechesFromSameCharacter ()
 
int32 getPauseAfterSpeechDuration () const
 
- 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

Common::String _phrase
 
int32 _character
 
bool _playTalkAnim
 
bool _removeTalkAnimWhenComplete
 
Sound * _soundResource
 
LipSync * _lipSync
 
int32 _waitTimeRemaining
 
- Protected Attributes inherited from Stark::Resources::Object
Type _type
 
byte _subType
 
uint16 _index
 
Common::String _name
 
Object * _parent
 
Common::Array< Object * > _children
 

Additional Inherited Members

- Static Public Member Functions inherited from Stark::Resources::Object
template<class T >
static T * cast (Object *resource)
 

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.

Member Function Documentation

◆ readData()

void Stark::Resources::Speech::readData ( Formats::XRCReadStream *  stream)
overridevirtual

Deserialize the resource static data and initial state.

Reimplemented from Stark::Resources::Object.

◆ onGameLoop()

void Stark::Resources::Speech::onGameLoop ( )
overridevirtual

Called once per game loop

Reimplemented from Stark::Resources::Object.

◆ onExitLocation()

void Stark::Resources::Speech::onExitLocation ( )
overridevirtual

Called when exiting a location

Reimplemented from Stark::Resources::Object.

◆ onPreDestroy()

void Stark::Resources::Speech::onPreDestroy ( )
overridevirtual

Called before a resource sub-tree is unloaded.

Reimplemented from Stark::Resources::Object.

◆ saveLoadCurrent()

void Stark::Resources::Speech::saveLoadCurrent ( ResourceSerializer *  serializer)
overridevirtual

Persist / restore the resource state

Called only for active locations

Reimplemented from Stark::Resources::Object.

◆ getPhrase()

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

Obtain the text associated to the speech line

◆ playSound()

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

Play the voice over

◆ isPlaying()

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

Return true if the speech is playing

◆ stop()

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

Stop the speech if it is playing

◆ characterIsApril()

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

Is the character saying the line April ?

◆ setPlayTalkAnim()

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

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

◆ getCharacterId()

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

Get the character's id - index in the KnowledgeSet

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