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
|
/* 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 3 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, see <http://www.gnu.org/licenses/>.
*
*/
#ifndef M4_H
#define M4_H
#include "common/scummsys.h"
#include "common/system.h"
#include "common/error.h"
#include "common/fs.h"
#include "common/hash-str.h"
#include "common/random.h"
#include "common/serializer.h"
#include "common/util.h"
#include "engines/engine.h"
#include "engines/savestate.h"
#include "graphics/screen.h"
#include "m4/detection.h"
#include "m4/vars.h"
#include "m4/core/rooms.h"
namespace M4 {
struct M4GameDescription;
class M4Engine : public Engine, public Sections {
private:
const M4GameDescription *_gameDescription;
Common::RandomSource _randomSource;
/**
* Main game loop
*/
void m4_inflight();
/**
* Opens up a savefile in a given slot, and if it's an
* original savegame, returns a reference to it
*/
Common::InSaveFile *getOriginalSave(int slot) const;
protected:
bool _useOriginalSaveLoad = false;
// Engine APIs
Common::Error run() override;
/**
* Creates globals
*/
virtual Vars *createVars() = 0;
/**
* Sets up the debugging console
*/
virtual void setupConsole() = 0;
public:
M4Engine(OSystem *syst, const M4GameDescription *gameDesc);
~M4Engine() override;
uint32 getFeatures() const;
bool useOriginalSaveLoad() const {
return _useOriginalSaveLoad;
}
/**
* Returns the game Id
*/
Common::String getGameId() const;
/**
* Returns the game type
*/
int getGameType() const;
/**
* Return game language
*/
Common::Language getLanguage() const;
/**
* Return if it's a demo
*/
int isDemo() const;
/**
* Gets a random number
*/
uint32 getRandomNumber(uint maxNum) {
return _randomSource.getRandomNumber(maxNum);
}
bool hasFeature(EngineFeature f) const override {
return
(f == kSupportsLoadingDuringRuntime) ||
(f == kSupportsSavingDuringRuntime) ||
(f == kSupportsReturnToLauncher);
};
bool canLoadGameStateCurrently(Common::U32String * msg = nullptr) override;
bool canSaveGameStateCurrently(Common::U32String *msg = nullptr) override;
void syncSoundSettings() override;
Common::Error loadGameState(int slot) override;
Common::Error loadGameStateDoIt(int slot);
/**
* Uses a serializer to allow implementing savegame
* loading and saving using a single method
*/
Common::Error syncGame(Common::Serializer &s);
virtual void syncFlags(Common::Serializer &s) = 0;
Common::Error saveGameStream(Common::WriteStream* stream, bool isAutosave = false) override;
Common::Error loadGameStream(Common::SeekableReadStream* stream) override;
/**
* Returns true if an autosave exists
*/
bool autosaveExists() const;
/**
* Returns true if any saves exist
*/
bool savesExist() const;
/**
* Lists the saves
*/
SaveStateList listSaves() const;
/**
* Returns the savegame thumbnail for a save
*/
bool loadSaveThumbnail(int slotNum, M4sprite *thumbnail) const;
/**
* Save game from in-game save menu
*/
bool saveGameFromMenu(int slotNum, const Common::String &desc,
Graphics::Surface &thumbnail);
/**
* Show save game dialog
*/
virtual void showSaveScreen();
enum LoadDialogSource { kLoadFromMainMenu, kLoadFromGameDialog, kLoadFromHotkey };
/**
* Show restore game dialog
*/
virtual void showLoadScreen(LoadDialogSource fromMainMenu);
/**
* Show the engine information
*/
virtual void showEngineInfo() = 0;
};
extern M4Engine *g_engine;
#define SHOULD_QUIT ::M4::g_engine->shouldQuit()
} // End of namespace M4
#endif // M4_H
|
