ScummVM API documentation
sword25.h
1 /* ScummVM - Graphic Adventure Engine
2  *
3  * ScummVM is the legal property of its developers, whose names
4  * are too numerous to list here. Please refer to the COPYRIGHT
5  * file distributed with this source distribution.
6  *
7  * This program is free software: you can redistribute it and/or modify
8  * it under the terms of the GNU General Public License as published by
9  * the Free Software Foundation, either version 3 of the License, or
10  * (at your option) any later version.
11  *
12  * This program is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15  * GNU General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License
18  * along with this program. If not, see <http://www.gnu.org/licenses/>.
19  *
20  */
21 
22 #ifndef SWORD25_SWORD25_H
23 #define SWORD25_SWORD25_H
24 
25 #include "common/scummsys.h"
26 #include "engines/engine.h"
27 
28 #include "sword25/console.h"
29 #include "sword25/detection.h"
30 
31 namespace Common {
32 class Error;
33 }
34 
35 namespace GUI {
36 class Debugger;
37 }
38 
39 struct ADGameDescription;
40 
49 namespace Sword25 {
50 
51 enum {
52  kFileTypeHash = 0
53 };
54 
55 enum {
56  kDebugScript = 1 << 0,
57  kDebugSound = 1 << 1,
58  kDebugResource = 1 << 2
59 };
60 
61 #define MESSAGE_BASIC 1
62 #define MESSAGE_INTERMEDIATE 2
63 #define MESSAGE_DETAILED 3
64 
65 class Sword25Engine : public Engine {
66 private:
67  Common::Error appStart();
68  bool appMain();
69  bool appEnd();
70 
71  bool loadPackages();
72 
73 protected:
74  Common::Error run() override;
75  bool hasFeature(EngineFeature f) const override;
76 // void pauseEngineIntern(bool pause); // TODO: Implement this!!!
77 // void syncSoundSettings(); // TODO: Implement this!!!
78 // Common::Error loadGameState(int slot); // TODO: Implement this?
79 // Common::Error saveGameState(int slot, const Common::String &desc, bool isAutosave = false); // TODO: Implement this?
80 // bool canLoadGameStateCurrently(); // TODO: Implement this?
81 // bool canSaveGameStateCurrently(); // TODO: Implement this?
82 
83  void shutdown();
84 
85 public:
86  Sword25Engine(OSystem *syst, const ADGameDescription *gameDesc);
87  ~Sword25Engine() override;
88 
89  uint32 getGameFlags() const;
90 
91  const ADGameDescription *_gameDescription;
92 };
93 
94 } // End of namespace Sword25
95 
96 #endif
EngineFeature
Definition: engine.h:253
Definition: error.h:84
Definition: advancedDetector.h:163
Definition: system.h:46
Definition: console.h:27
Definition: sword25.h:65
Definition: algorithm.h:29
Definition: system.h:161
Definition: engine.h:144