ScummVM API documentation
debugger.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 KYRA_DEBUGGER_H
23 #define KYRA_DEBUGGER_H
24 
25 #include "gui/debugger.h"
26 
27 namespace Kyra {
28 
29 class KyraEngine_v1;
30 class KyraEngine_LoK;
31 class KyraEngine_v2;
32 class KyraEngine_HoF;
33 
34 class Debugger : public ::GUI::Debugger {
35 public:
37 
38  virtual void initialize();
39 
40 protected:
41  KyraEngine_v1 *_vm;
42 
43  bool cmdSetScreenDebug(int argc, const char **argv);
44  bool cmdLoadPalette(int argc, const char **argv);
45  bool cmdShowFacings(int argc, const char **argv);
46  bool cmdGameSpeed(int argc, const char **argv);
47  bool cmdListFlags(int argc, const char **argv);
48  bool cmdToggleFlag(int argc, const char **argv);
49  bool cmdQueryFlag(int argc, const char **argv);
50  bool cmdListTimers(int argc, const char **argv);
51  bool cmdSetTimerCountdown(int argc, const char **argv);
52 };
53 
54 class Debugger_LoK : public Debugger {
55 public:
57 
58  void initialize() override;
59 protected:
60  KyraEngine_LoK *_vm;
61 
62  bool cmdEnterRoom(int argc, const char **argv);
63  bool cmdListScenes(int argc, const char **argv);
64  bool cmdGiveItem(int argc, const char **argv);
65  bool cmdListBirthstones(int argc, const char **argv);
66 };
67 
68 class Debugger_v2 : public Debugger {
69 public:
71  ~Debugger_v2() override {}
72 
73  void initialize() override;
74 protected:
75  KyraEngine_v2 *_vm;
76 
77  bool cmdEnterScene(int argc, const char **argv);
78  bool cmdListScenes(int argc, const char **argv);
79  bool cmdSceneInfo(int argc, const char **argv);
80  bool cmdCharacterInfo(int argc, const char **argv);
81  bool cmdSceneToFacing(int argc, const char **argv);
82  bool cmdGiveItem(int argc, const char **argv);
83 };
84 
85 class Debugger_HoF : public Debugger_v2 {
86 public:
88 
89  void initialize() override;
90 protected:
91  KyraEngine_HoF *_vm;
92 
93  bool cmdPasscodes(int argc, const char **argv);
94 };
95 
96 #ifdef ENABLE_LOL
97 class LoLEngine;
98 
99 class Debugger_LoL : public Debugger {
100 public:
101  Debugger_LoL(LoLEngine *vm);
102 
103 protected:
104  LoLEngine *_vm;
105 };
106 #endif // ENABLE_LOL
107 
108 #ifdef ENABLE_EOB
109 class EoBCoreEngine;
110 
111 class Debugger_EoB : public Debugger {
112 public:
113  Debugger_EoB(EoBCoreEngine *vm);
114 
115  void initialize() override;
116 protected:
117  EoBCoreEngine *_vm;
118 
119  bool cmdImportSaveFile(int argc, const char **argv);
120  bool cmdSaveOriginal(int argc, const char **argv);
121  bool cmdListMonsters(int argc, const char **argv);
122  bool cmdShowPosition(int argc, const char **argv);
123  bool cmdSetPosition(int argc, const char **argv);
124  bool cmdPrintMap(int argc, const char **argv);
125  bool cmdOpenDoor(int argc, const char **argv);
126  bool cmdCloseDoor(int argc, const char **argv);
127  bool cmdListFlags(int argc, const char **argv);
128  bool cmdSetFlag(int argc, const char **argv);
129  bool cmdClearFlag(int argc, const char **argv);
130 };
131 #endif // ENABLE_EOB
132 
133 } // End of namespace Kyra
134 
135 #endif
Definition: debugger.h:41
Definition: kyra_v1.h:126
Definition: kyra_v2.h:53
Definition: kyra_hof.h:44
Definition: kyra_lok.h:97
Definition: detection.h:27
Definition: debugger.h:34
Definition: debugger.h:68
Definition: debugger.h:54
Definition: debugger.h:85