1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
|
/* ScummVM - Graphic Adventure Engine
*
* ScummVM is the legal property of its developers, whose names
* are too numerous to list here. Please refer to the COPYRIGHT
* file distributed with this source distribution.
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation; either version 2
* of the License, or (at your option) any later version.
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*
*/
#ifndef XEEN_SUBTITLES_H
#define XEEN_SUBTITLES_H
#include "common/str-array.h"
#include "xeen/sprites.h"
namespace Xeen {
class Subtitles {
private:
Common::StringArray _lines;
int _lineNum;
SpriteResource *_boxSprites;
int _lineEnd, _lineSize;
Common::String _displayLine;
private:
/**
* Loads the string list of all subtitles
*/
void loadSubtitles();
/**
* Mark the current time
*/
void markTime();
/**
* Returns true if the time for a subtitle frame has expired
*/
bool timeElapsed() const;
public:
/**
* Constructor
*/
Subtitles();
/**
* Destructor
*/
virtual ~Subtitles();
/**
* Set which subtitle line to display
*/
void setLine(int line);
/**
* Resets subtitles, stopping any display
*/
void reset();
/**
* Returns true if a subtitle is active
*/
bool active() const;
/**
* Returns true if a subtitle is active or a voice line is currently being played
*/
bool lineActive() const;
/**
* Shows any active subtitle
*/
void show();
/**
* Waits for a given number of frames
* @param numFrames Number of frames to wait
* @param interruptable If set, aborts if the mouse or a key is pressed
* @returns True if the wait was aborted
*/
bool wait(uint numFrames, bool interruptable = true);
/**
* Wait for the end of currently playing sound or subtitles line
*/
bool waitForLineOrSound();
};
} // End of namespace Xeen
#endif /* XEEN_SUBTITLES_H */
|
