ScummVM API documentation
console.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 SAGA2_CONSOLE_H
23#define SAGA2_CONSOLE_H
24
25#include "gui/debugger.h"
26
27#include "saga2/tcoords.h"
28
29namespace Saga2 {
30
31class Saga2Engine;
32
33class Console : public GUI::Debugger {
34public:
36 ~Console() override;
37
38private:
39 Saga2Engine *_vm;
40
41 TilePoint _savedLoc;
42
43 // Input: <None>. Kills the center actor.
44 bool cmdKillProtag(int argc, const char **argv);
45 // Input: <Actor ID>. Kills an actor.
46 bool cmdKill(int argc, const char **argv);
47 // Input: <Object ID>. Prints an object's name.
48 bool cmdObjName(int argc, const char **argv);
49 // Input: <Name Index>. Prints an ObjectID corresponding to the name index.
50 bool cmdObjNameIndexToID(int argc, const char **argv);
51 // Input: <Object Name>. Prints a list of objects containing the string in their name.
52 bool cmdSearchObj(int argc, const char **argv);
53 // Input: <Object ID>. Adds the object to the center actor's inventory.
54 bool cmdAddObj(int argc, const char **argv);
55 // Input: <1/0>. Sets godmode.
56 bool cmdGodmode(int argc, const char **argv);
57 // Input: <1/0>. Sets whether the position coordinates show.
58 bool cmdPosition(int argc, const char **argv);
59 // Input: <1/0>. Sets whether an item's stats show when holding it.
60 bool cmdStats(int argc, const char **argv);
61 // Input: <1/0>. Sets whether the original debug status messages show.
62 bool cmdStatusMsg(int argc, const char **argv);
63 // Input: <1/0>. Sets whether you can teleport by right clicking on the screen.
64 bool cmdTeleportOnClick(int argc, const char **argv);
65 // Input: <1/0>. Sets whether you can teleport by clicking on the map.
66 bool cmdTeleportOnMap(int argc, const char **argv);
67 // Input: <u> <v> <z>. Teleports the center character to the given position.
68 bool cmdTeleport(int argc, const char **argv);
69 // Input: <Actor ID>. Teleports the character to the npc.
70 bool cmdTeleportToNPC(int argc, const char **argv);
71 // Input: <Actor ID> <u> <v> <z>. Teleports the npc to the given position.
72 bool cmdTeleportNPC(int argc, const char **argv);
73 // Input: <Actor ID>. Teleports the npc to the center actor.
74 bool cmdTeleportNPCHere(int argc, const char **argv);
75 // Input: <None>. Teleport the three brothers to the center actor.
76 bool cmdTeleportPartyHere(int argc, const char **argv);
77 // Input: <place id>/<place name>. Teleports the center character to the given place name or number.
78 bool cmdTeleportPlace(int argc, const char **argv);
79 // Input: <None>. Saves the current location locally.
80 bool cmdSaveLoc(int argc, const char **argv);
81 // Input: <None>. Teleports the center actor to the location saved with cmdSaveLoc.
82 bool cmdLoadLoc(int argc, const char **argv);
83 // Input: <Place ID>. Teleports to the given place.
84 bool cmdGotoPlace(int argc, const char **argv);
85 // Input: <None>. Lists all of the place names along with their IDs.
86 bool cmdListPlaces(int argc, const char **argv);
87 // Input: <Map Scale Multiplier>. Dumps the map into a png.
88 bool cmdDumpMap(int argc, const char **argv);
89 // Input: <Music Index>. Plays a music track.
90 bool cmdPlayMusic(int argc, const char **argv);
91 // Input: <Voice ID>. Plays a voice track.
92 bool cmdPlayVoice(int argc, const char **argv);
93 // Input: <1/0>. Sets the invisibility effect on the party.
94 bool cmdInvisibility(int argc, const char **argv);
95 // Input: <1/0>. Sets state of Automap cheat for testing.
96 bool cmdMapCheat(int argc, const char **argv);
97};
98
99}
100
101#endif
Definition: debugger.h:41
Definition: console.h:33
Definition: saga2.h:107
Definition: tcoords.h:127