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 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233
|
/* 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 SHERLOCK_SHERLOCK_H
#define SHERLOCK_SHERLOCK_H
#include "common/scummsys.h"
#include "common/array.h"
#include "common/endian.h"
#include "common/hash-str.h"
#include "common/serializer.h"
#include "common/random.h"
#include "common/savefile.h"
#include "common/util.h"
#include "engines/engine.h"
#include "sherlock/animation.h"
#include "sherlock/debugger.h"
#include "sherlock/events.h"
#include "sherlock/fixed_text.h"
#include "sherlock/inventory.h"
#include "sherlock/journal.h"
#include "sherlock/map.h"
#include "sherlock/music.h"
#include "sherlock/people.h"
#include "sherlock/resources.h"
#include "sherlock/saveload.h"
#include "sherlock/scene.h"
#include "sherlock/screen.h"
#include "sherlock/sound.h"
#include "sherlock/talk.h"
#include "sherlock/user_interface.h"
namespace Sherlock {
enum {
kDebugLevelScript = 1 << 0,
kDebugLevelAdLibDriver = 2 << 0,
kDebugLevelMT32Driver = 3 << 0,
kDebugLevelMusic = 4 << 0
};
enum GameType {
GType_SerratedScalpel = 0,
GType_RoseTattoo = 1
};
#define SHERLOCK_SCREEN_WIDTH _vm->_screen->width()
#define SHERLOCK_SCREEN_HEIGHT _vm->_screen->height()
#define SHERLOCK_SCENE_WIDTH _vm->_screen->_backBuffer1.width()
#define SHERLOCK_SCENE_HEIGHT (IS_SERRATED_SCALPEL ? 138 : 480)
#define SCENES_COUNT (IS_SERRATED_SCALPEL ? 63 : 101)
#define MAX_BGSHAPES (IS_SERRATED_SCALPEL ? 64 : 150)
#define COL_INFO_FOREGROUND (IS_SERRATED_SCALPEL ? (byte)Scalpel::INFO_FOREGROUND : (byte)Tattoo::INFO_FOREGROUND)
#define COL_PEN_COLOR (IS_SERRATED_SCALPEL ? (byte)Scalpel::PEN_COLOR : (byte)Tattoo::PEN_COLOR)
#define COL_PEN_HIGHLIGHT (IS_SERRATED_SCALPEL ? 15 : 129)
struct SherlockGameDescription;
class Resource;
class SherlockEngine : public Engine {
private:
\
/**
* Main loop for displaying a scene and handling all that occurs within it
*/
void sceneLoop();
/**
* Handle all player input
*/
void handleInput();
protected:
/**
* Does basic initialization of the game engine
*/
virtual void initialize();
virtual void showOpening() = 0;
virtual void startScene() {}
/**
* Returns a list of features the game itself supports
*/
virtual bool hasFeature(EngineFeature f) const;
/**
* Load game configuration esttings
*/
virtual void loadConfig();
public:
const SherlockGameDescription *_gameDescription;
Animation *_animation;
Debugger *_debugger;
Events *_events;
FixedText *_fixedText;
Inventory *_inventory;
Journal *_journal;
Map *_map;
Music *_music;
People *_people;
Resources *_res;
SaveManager *_saves;
Scene *_scene;
Screen *_screen;
Sound *_sound;
Talk *_talk;
UserInterface *_ui;
Common::RandomSource _randomSource;
Common::Array<bool> _flags;
bool _useEpilogue2;
int _loadGameSlot;
bool _canLoadSave;
bool _showOriginalSavesDialog;
bool _interactiveFl;
bool _isScreenDoubled;
public:
SherlockEngine(OSystem *syst, const SherlockGameDescription *gameDesc);
virtual ~SherlockEngine();
/**
* Main method for running the game
*/
virtual Common::Error run();
/**
* Returns true if a savegame can be loaded
*/
virtual bool canLoadGameStateCurrently();
/**
* Returns true if the game can be saved
*/
virtual bool canSaveGameStateCurrently();
/**
* Called by the GMM to load a savegame
*/
virtual Common::Error loadGameState(int slot);
/**
* Called by the GMM to save the game
*/
virtual Common::Error saveGameState(int slot, const Common::String &desc);
/**
* Called by the engine when sound settings are updated
*/
virtual void syncSoundSettings();
/**
* Saves game configuration information
*/
virtual void saveConfig();
/**
* Returns whether the version is a demo
*/
virtual bool isDemo() const;
/**
* Returns the Id of the game
*/
GameType getGameID() const;
/**
* Returns the platform the game's datafiles are for
*/
Common::Platform getPlatform() const;
/**
* Return the game's language
*/
Common::Language getLanguage() const;
/**
* Return a random number
*/
int getRandomNumber(int limit) { return _randomSource.getRandomNumber(limit - 1); }
/**
* Read the state of a global flag
* @remarks If a negative value is specified, it will return the inverse value
* of the positive flag number
*/
bool readFlags(int flagNum);
/**
* Sets a global flag to either true or false depending on whether the specified
* flag is positive or negative
*/
void setFlags(int flagNum);
/**
* Set a global flag to 0 or 1 depending on whether the passed flag is negative or positive.
* @remarks We don't use the global setFlags method because we don't want to check scene flags
*/
void setFlagsDirect(int flagNum);
/**
* Synchronize the data for a savegame
*/
void synchronize(Serializer &s);
};
#define IS_ROSE_TATTOO (_vm->getGameID() == GType_RoseTattoo)
#define IS_SERRATED_SCALPEL (_vm->getGameID() == GType_SerratedScalpel)
#define IS_3DO (_vm->getPlatform() == Common::kPlatform3DO)
} // End of namespace Sherlock
#endif
|