XEEN: Implementing subtitles display logic

1 files changed, 100 insertions, 0 deletions

diff --git a/engines/xeen/subtitles.h b/engines/xeen/subtitles.h
new file mode 100644
index 0000000000..c041db2718
--- /dev/null
+++ b/engines/xeen/subtitles.h
@@ -0,0 +1,100 @@
+/* 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;
+	uint32 _frameExpiryTime;
+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
+	 */
+	~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;
+
+	/**
+	 * Shows any active subtitle
+	 * @param windowNum		Window to render to
+	 */
+	void show(uint windowNum = 0);
+
+	/**
+	 * Delays either the specified number of frames, or until
+	 * an entire subtitle line is shown if subtitles are on
+	 */
+	bool wait(uint minTime = 0);
+
+	/**
+	 * Wait for the end of currently playing sound or subtitles line
+	 */
+	bool waitForLineOrSound();
+};
+
+} // End of namespace Xeen
+
+#endif /* XEEN_SUBTITLES_H */