XEEN: Rename Town to LocationManager, added Locations namespace

1 files changed, 371 insertions, 0 deletions

diff --git a/engines/xeen/locations.h b/engines/xeen/locations.h
new file mode 100644
index 0000000000..e0f4838fd6
--- /dev/null
+++ b/engines/xeen/locations.h
@@ -0,0 +1,371 @@
+/* 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_LOCATIONS_H
+#define XEEN_LOCATIONS_H
+
+#include "common/scummsys.h"
+#include "common/str-array.h"
+#include "xeen/dialogs.h"
+#include "xeen/dialogs_error.h"
+#include "xeen/party.h"
+
+namespace Xeen {
+
+enum LocationAction {
+	BANK = 0, BLACKSMITH = 1, GUILD = 2, TAVERN = 3, TEMPLE = 4,
+	TRAINING = 5, ARENA = 6, NO_ACTION = 7, REAPER = 8, GOLEM = 9,
+	DWARF1 = 10, SPHINX = 11, PYRAMID = 12, DWARF2 = 13
+};
+
+class XeenEngine;
+
+namespace Locations {
+
+class BaseLocation : public ButtonContainer {
+protected:
+	LocationAction _LocationActionId;
+	Common::Array<SpriteResource> _townSprites;
+	SpriteResource _icons1, _icons2;
+	int _townMaxId;
+	const bool &_isDarkCc;
+	int _animFrame;
+	Common::String _vocName, _songName;
+	Common::Point _townPos;
+	int _drawFrameIndex;
+	uint _farewellTime;
+	int _drawCtr1, _drawCtr2;
+protected:
+	/**
+	 * Draw the window
+	 */
+	void drawWindow();
+
+	/**
+	 * Waits for a brief pause, checking for any key or mouse events
+	 */
+	int wait();
+
+	/**
+	 * Generates the display text for the location, for a given character
+	 */
+	virtual Common::String createLocationText(Character &ch) { return ""; }
+
+	/**
+	 * Draw the visual background
+	 */
+	virtual void drawBackground();
+
+	/**
+	 * Handles options for the particular location
+	 */
+	virtual Character *doOptions(Character *c) { return c; }
+
+	/**
+	 * Handle any farewell
+	 */
+	virtual void farewell() {}
+public:
+	BaseLocation(LocationAction action);
+	virtual ~BaseLocation();
+
+	/**
+	 * Show the town location
+	 */
+	virtual int show();
+
+	/**
+	 * Draws the animated parts
+	 */
+	void drawAnim(bool flag);
+};
+
+class BankLocation : public BaseLocation {
+private:
+	/**
+	 * Handles deposits or withdrawls fro the bank
+	 */
+	void depositWithdrawl(PartyBank whereId);
+protected:
+	/**
+	 * Generates the display text for the location, for a given character
+	 */
+	virtual Common::String createLocationText(Character &ch);
+
+	/**
+	 * Draw the visual background
+	 */
+	virtual void drawBackground();
+
+	/**
+	 * Handles options for the particular location
+	 */
+	virtual Character *doOptions(Character *c);
+public:
+	BankLocation();
+	virtual ~BankLocation() {}
+};
+
+class BlacksmithLocation : public BaseLocation {
+protected:
+	/**
+	* Generates the display text for the location, for a given character
+	*/
+	virtual Common::String createLocationText(Character &ch);
+
+	/**
+	 * Handle any farewell
+	 */
+	virtual void farewell();
+
+	/**
+	 * Handles options for the particular location
+	 */
+	virtual Character *doOptions(Character *c);
+public:
+	BlacksmithLocation();
+	virtual ~BlacksmithLocation() {}
+};
+
+class GuildLocation : public BaseLocation {
+protected:
+	/**
+	 * Generates the display text for the location, for a given character
+	 */
+	virtual Common::String createLocationText(Character &ch);
+
+	/**
+	 * Handles options for the particular location
+	 */
+	virtual Character *doOptions(Character *c);
+public:
+	GuildLocation();
+	virtual ~GuildLocation() {}
+};
+
+class TavernLocation : public BaseLocation {
+private:
+	int _v21;
+	uint _v22;
+	int _v23;
+	int _v24;
+protected:
+	/**
+	* Generates the display text for the location, for a given character
+	*/
+	virtual Common::String createLocationText(Character &ch);
+
+	/**
+	 * Handle any farewell
+	 */
+	virtual void farewell();
+
+	/**
+	 * Handles options for the particular location
+	 */
+	virtual Character *doOptions(Character *c);
+public:
+	TavernLocation();
+	virtual ~TavernLocation() {}
+};
+
+class TempleLocation : public BaseLocation {
+private:
+	int _currentCharLevel;
+	int _donation;
+	int _healCost;
+	int _uncurseCost;
+	int _dayOfWeek;
+	int _v10, _v11, _v12;
+	int _v13, _v14;
+	bool _flag1;
+	int _v5, _v6;
+protected:
+	/**
+	* Generates the display text for the location, for a given character
+	*/
+	virtual Common::String createLocationText(Character &ch);
+
+	/**
+	 * Handles options for the particular location
+	 */
+	virtual Character *doOptions(Character *c);
+public:
+	TempleLocation();
+	virtual ~TempleLocation() {}
+};
+
+class TrainingLocation : public BaseLocation {
+private:
+	int _charIndex;
+	bool _charsTrained[MAX_ACTIVE_PARTY];
+	uint _experienceToNextLevel;
+	uint _maxLevel;
+protected:
+	/**
+	 * Generates the display text for the location, for a given character
+	 */
+	virtual Common::String createLocationText(Character &ch);
+
+	/**
+	 * Handles options for the particular location
+	 */
+	virtual Character *doOptions(Character *c);
+public:
+	TrainingLocation();
+	virtual ~TrainingLocation() {}
+};
+
+class ArenaLocation : public BaseLocation {
+public:
+	ArenaLocation();
+	virtual ~ArenaLocation() {}
+};
+
+class CutsceneLocation : public BaseLocation {
+protected:
+	int _animCtr;
+	SpriteResource _boxSprites;
+	int _mazeId;
+	Direction _mazeDir;
+	Common::Point _mazePos;
+	bool _mazeFlag;
+protected:
+	/**
+	* Handles cutscene animation update
+	*/
+	void cutsceneAnimUpdate();
+
+	/**
+	 * Sets the new location
+	 */
+	void setNewLocation();
+public:
+	CutsceneLocation(LocationAction action);
+};
+
+class ReaperCutscene : public CutsceneLocation {
+public:
+	ReaperCutscene();
+	virtual ~ReaperCutscene() {}
+};
+
+class GolemCutscene : public CutsceneLocation {
+public:
+	GolemCutscene();
+	virtual ~GolemCutscene() {}
+};
+
+class DwarfCutscene : public CutsceneLocation {
+private:
+	/**
+	 * Get the new location
+	 */
+	void getNewLocation();
+public:
+	DwarfCutscene(bool isDwarf1);
+	virtual ~DwarfCutscene() {}
+
+	/**
+	 * Show the town location
+	 */
+	virtual int show();
+};
+
+class SphinxCutscene : public CutsceneLocation {
+private:
+	/**
+	 * Get the new location
+	 */
+	void getNewLocation();
+public:
+	SphinxCutscene();
+	virtual ~SphinxCutscene() {}
+};
+
+class PyramidLocation : public BaseLocation {
+public:
+	PyramidLocation();
+	virtual ~PyramidLocation() {}
+
+	/**
+	 * Show the town location
+	 */
+	virtual int show();
+};
+
+} // End of namespace Locations
+
+class LocationMessage : public Locations::BaseLocation {
+private:
+	SpriteResource _iconSprites;
+
+	LocationMessage() : Locations::BaseLocation(NO_ACTION) {}
+
+	bool execute(int portrait, const Common::String &name,
+		const Common::String &text, int confirm);
+
+	void loadButtons();
+public:
+	static bool show(int portrait, const Common::String &name,
+		const Common::String &text, int confirm);
+};
+
+class LocationManager {
+private:
+	Locations::BaseLocation *_location;
+private:
+	int townWait();
+
+	Character *doBankOptions(Character *c);
+
+	Character *doBlacksmithOptions(Character *c);
+
+	Character *doGuildOptions(Character *c);
+
+	Character *doTavernOptions(Character *c);
+
+	Character *doTempleOptions(Character *c);
+
+	Character *doTrainingOptions(Character *c);
+public:
+	LocationManager();
+
+	/**
+	* Show a given location, and return any result
+	*/
+	int doAction(LocationAction actionId);
+
+	/**
+	* Returns true if a town location (bank, blacksmith, etc.) is currently active
+	*/
+	bool isActive() const;
+
+	/**
+	* Draws a currently active town location's animation
+	*/
+	void drawAnim(bool flag);
+};
+
+} // End of namespace Xeen
+
+#endif /* XEEN_LOCATIONS_H */