File: mtropolis.h

package info (click to toggle)
scummvm 2.9.1%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 450,580 kB
  • sloc: cpp: 4,299,825; asm: 28,322; python: 12,901; sh: 11,302; java: 9,289; xml: 7,895; perl: 2,639; ansic: 2,465; yacc: 1,670; javascript: 1,020; makefile: 933; lex: 578; awk: 275; objc: 82; sed: 11; php: 1
file content (102 lines) | stat: -rw-r--r-- 3,291 bytes parent folder | download | duplicates (2)
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
/* 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 MTROPOLIS_MTROPOLIS_H
#define MTROPOLIS_MTROPOLIS_H

#include "engines/engine.h"

#include "common/random.h"

#include "mtropolis/detection.h"
#include "mtropolis/saveload.h"

/**
 * This is the namespace of the mTropolis engine.
 *
 * Status of this engine:
 *
 * Supports some games, tends to be buggy outside of those.
 * Requires a boot list to start a game due to complex installer
 * configurations.
 *
 * Games using this engine:
 * - Obsidian
 * - Muppet Treasure Island
 */
namespace MTropolis {

class Runtime;
class RuntimeObject;

class MTropolisEngine : public ::Engine, public ISaveUIProvider, public ILoadUIProvider, public IAutoSaveProvider {
protected:
	// Engine APIs
	Common::Error run() override;

public:
	MTropolisEngine(OSystem *syst, const MTropolisGameDescription *gameDesc);
	~MTropolisEngine() override;

	bool hasFeature(EngineFeature f) const override;
	//void syncSoundSettings() override;

	const MTropolisGameDescription *_gameDescription;
	uint32 getGameID() const;
	Common::Platform getPlatform() const;

	bool promptSave(ISaveWriter *writer, const Graphics::Surface *screenshotOverride) override;
	bool namedSave(ISaveWriter *writer, const Graphics::Surface *screenshotOverride, const Common::String &fileName) override;
	bool autoSave(ISaveWriter *writer) override;
	bool promptLoad(ISaveReader *reader) override;
	bool namedLoad(ISaveReader *reader, const Common::String &fileName) override;

	const Graphics::Surface *getSavegameScreenshot() const;

	Common::Error saveGameStream(Common::WriteStream *stream, bool isAutosave) override;
	bool canSaveAutosaveCurrently() override;
	bool canSaveGameStateCurrently(Common::U32String *msg = nullptr) override;	

public:
	void handleEvents();

protected:
	void pauseEngineIntern(bool pause) override;

private:
	bool save(ISaveWriter *writer, const Graphics::Surface *screenshotOverride, const Common::String &fileName, const Common::String &desc);
	bool load(ISaveReader *reader, const Common::String &fileName);

	Common::String getUnpromptedSaveFileName(const Common::String &fileName);

	static const uint kCurrentSaveFileVersion = 2;
	static const uint kEarliestSupportedSaveFileVersion = 2;
	static const uint kSavegameSignature = 0x6d545356;	// mTSV

	ISaveWriter *_saveWriter;
	bool _isTriggeredAutosave;

	Common::ScopedPtr<Runtime> _runtime;
};

} // End of namespace MTropolis

#endif /* MTROPOLIS_MTROPOLIS_H */