ScummVM API documentation
MM::Xeen::Subtitles Class Reference

Public Member Functions

 Subtitles ()
 
virtual ~Subtitles ()
 
void setLine (int line)
 
void reset ()
 
bool active () const
 
bool lineActive () const
 
void show ()
 
bool wait (uint numFrames, bool interruptable=true)
 
bool waitForLineOrSound ()
 

Constructor & Destructor Documentation

◆ Subtitles()

MM::Xeen::Subtitles::Subtitles ( )

Constructor

◆ ~Subtitles()

virtual MM::Xeen::Subtitles::~Subtitles ( )
virtual

Destructor

Member Function Documentation

◆ setLine()

void MM::Xeen::Subtitles::setLine ( int  line)

Set which subtitle line to display

◆ reset()

void MM::Xeen::Subtitles::reset ( )

Resets subtitles, stopping any display

◆ active()

bool MM::Xeen::Subtitles::active ( ) const

Returns true if a subtitle is active

◆ lineActive()

bool MM::Xeen::Subtitles::lineActive ( ) const

Returns true if a subtitle is active or a voice line is currently being played

◆ show()

void MM::Xeen::Subtitles::show ( )

Shows any active subtitle

◆ wait()

bool MM::Xeen::Subtitles::wait ( uint  numFrames,
bool  interruptable = true 
)

Waits for a given number of frames

Parameters
numFramesNumber of frames to wait
interruptableIf set, aborts if the mouse or a key is pressed
Returns
True if the wait was aborted

◆ waitForLineOrSound()

bool MM::Xeen::Subtitles::waitForLineOrSound ( )

Wait for the end of currently playing sound or subtitles line


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