scummvm/engines/mohawk/mohawk.h
2014-02-18 02:39:36 +01:00

132 lines
3.3 KiB
C++

/* 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 MOHAWK_H
#define MOHAWK_H
#include "common/scummsys.h"
#include "common/array.h"
#include "engines/engine.h"
#include "mohawk/video.h"
class OSystem;
namespace Common {
class SeekableReadStream;
}
/**
* This is the namespace of the Mohawk engine.
*
* Status of this engine: ???
*
* Games using this engine:
* - Myst
* - Riven: The Sequel to Myst
*/
namespace Mohawk {
enum MohawkGameType {
GType_MYST,
GType_MAKINGOF,
GType_RIVEN,
GType_ZOOMBINI,
GType_CSTIME,
GType_CSWORLD,
GType_CSAMTRAK,
GType_JAMESMATH,
GType_TREEHOUSE,
GType_1STDEGREE,
GType_CSUSA,
GType_LIVINGBOOKSV1,
GType_LIVINGBOOKSV2,
GType_LIVINGBOOKSV3,
GType_LIVINGBOOKSV4,
GType_LIVINGBOOKSV5
};
enum MohawkGameFeatures {
GF_ME = (1 << 0), // Myst Masterpiece Edition
GF_DVD = (1 << 1),
GF_DEMO = (1 << 2),
GF_HASMIDI = (1 << 3),
GF_LB_10 = (1 << 4) // very early Living Books 1.0 games
};
struct MohawkGameDescription;
class Sound;
class PauseDialog;
class Archive;
class CursorManager;
class MohawkEngine : public ::Engine {
protected:
virtual Common::Error run();
public:
MohawkEngine(OSystem *syst, const MohawkGameDescription *gamedesc);
virtual ~MohawkEngine();
// Detection related functions
const MohawkGameDescription *_gameDescription;
const char *getGameId() const;
uint32 getFeatures() const;
const char *getAppName() const;
uint16 getVersion() const;
Common::Platform getPlatform() const;
uint8 getGameType() const;
Common::Language getLanguage() const;
bool hasFeature(EngineFeature f) const;
Sound *_sound;
VideoManager *_video;
CursorManager *_cursor;
virtual Common::SeekableReadStream *getResource(uint32 tag, uint16 id);
bool hasResource(uint32 tag, uint16 id);
bool hasResource(uint32 tag, const Common::String &resName);
uint32 getResourceOffset(uint32 tag, uint16 id);
uint16 findResourceID(uint32 type, const Common::String &resName);
Common::String getResourceName(uint32 tag, uint16 id);
void pauseGame();
// Check if events should be done based on a video's current time
// (currently only used for Riven's storeMovieOpcode function)
virtual void doVideoTimer(VideoHandle handle, bool force) {}
private:
PauseDialog *_pauseDialog;
void pauseEngineIntern(bool);
protected:
// An array holding the main Mohawk archives require by the games
Common::Array<Archive *> _mhk;
};
} // End of namespace Mohawk
#endif