ScummVM API documentation
Asylum::Speech Class Reference

Public Member Functions

 Speech (AsylumEngine *engine)
 
ResourceId play (ResourceId soundResourceId, ResourceId textResourceId)
 
void prepareSpeech ()
 
ResourceId playIndexed (int32 index)
 
ResourceId playScene (int32 type, int32 index)
 
ResourceId playPlayer (int32 index)
 
void resetResourceIds ()
 
void resetTextData ()
 
ResourceId getSoundResourceId () const
 
void setTick (int32 val)
 
uint32 getTick ()
 
void setSoundResourceId (ResourceId id)
 
void setTextResourceId (ResourceId id)
 
ResourceId getTextResourceId ()
 
void setTextData (char *text)
 
char * getTextData ()
 
void setTextDataPos (char *text)
 
char * getTextDataPos ()
 

Member Function Documentation

◆ play()

ResourceId Asylum::Speech::play ( ResourceId  soundResourceId,
ResourceId  textResourceId 
)

Play speech

Parameters
soundResourceIdThe sound resource id.
textResourceIdThe text resource id.

◆ prepareSpeech()

void Asylum::Speech::prepareSpeech ( )

Prepare speech to play

  • Process sound speech and draws dialog in screen

◆ playIndexed()

ResourceId Asylum::Speech::playIndexed ( int32  index)

Play speech by index offset.

Parameters
indexThe index offset.
Returns
the ResourceId for the sound played

◆ playScene()

ResourceId Asylum::Speech::playScene ( int32  type,
int32  index 
)

Play scene speech.

Parameters
typeThe type of speech to play.
indexThe index offset.
Returns
the ResourceId for the sound played

◆ playPlayer()

ResourceId Asylum::Speech::playPlayer ( int32  index)

Play speech by index offset (based on player type)

Parameters
indexThe index offset.
Returns
the ResourceId for the sound played

◆ resetResourceIds()

void Asylum::Speech::resetResourceIds ( )

Resets the resource identifiers.

◆ resetTextData()

void Asylum::Speech::resetTextData ( )

Resets text data

◆ getSoundResourceId()

ResourceId Asylum::Speech::getSoundResourceId ( ) const
inline

Gets the sound resource identifier.

Returns
The sound resource identifier.

◆ setTick()

void Asylum::Speech::setTick ( int32  val)
inline

Sets the tick.

Parameters
valThe value.

◆ getTick()

uint32 Asylum::Speech::getTick ( )
inline

Gets the tick.

Returns
The tick.

◆ setSoundResourceId()

void Asylum::Speech::setSoundResourceId ( ResourceId  id)
inline

Sets the sound resource identifier

Parameters
idThe sound resource identifier.

◆ setTextResourceId()

void Asylum::Speech::setTextResourceId ( ResourceId  id)
inline

Sets the text resource identifier

Parameters
idThe text resource identifier.

◆ getTextResourceId()

ResourceId Asylum::Speech::getTextResourceId ( )
inline

Gets the text resource identifier.

Returns
The text resource identifier.

◆ setTextData()

void Asylum::Speech::setTextData ( char *  text)
inline

Sets text data.

Parameters
textThe text.

◆ getTextData()

char* Asylum::Speech::getTextData ( )
inline

Get text data

Returns
the text data

◆ setTextDataPos()

void Asylum::Speech::setTextDataPos ( char *  text)
inline

Sets text data position.

Parameters
textThe text.

◆ getTextDataPos()

char* Asylum::Speech::getTextDataPos ( )
inline

Get text data position

Returns
the text data position

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