yaze 0.3.2
Link to the Past ROM Editor
 
Loading...
Searching...
No Matches
dungeon_edit_commands.h
Go to the documentation of this file.
1#ifndef YAZE_SRC_CLI_HANDLERS_GAME_DUNGEON_EDIT_COMMANDS_H_
2#define YAZE_SRC_CLI_HANDLERS_GAME_DUNGEON_EDIT_COMMANDS_H_
3
5
6namespace yaze {
7namespace cli {
8namespace handlers {
9
16 public:
17 std::string GetName() const override { return "dungeon-place-sprite"; }
18 std::string GetDescription() const {
19 return "Place a sprite in a dungeon room";
20 }
21 std::string GetUsage() const override {
22 return "dungeon-place-sprite --room <hex> --id <hex> --x <int> --y <int> "
23 "[--subtype <int>] [--layer <0|1>] "
24 "[--write] [--format <json|text>]";
25 }
26
27 absl::Status ValidateArgs(const resources::ArgumentParser& parser) override {
28 return parser.RequireArgs({"room", "id", "x", "y"});
29 }
30
31 absl::Status Execute(Rom* rom, const resources::ArgumentParser& parser,
32 resources::OutputFormatter& formatter) override;
33};
34
41 public:
42 std::string GetName() const override { return "dungeon-remove-sprite"; }
43 std::string GetDescription() const {
44 return "Remove a sprite from a dungeon room";
45 }
46 std::string GetUsage() const override {
47 return "dungeon-remove-sprite --room <hex> "
48 "[--index <int> | --x <int> --y <int>] "
49 "[--write] [--format <json|text>]";
50 }
51
52 absl::Status ValidateArgs(const resources::ArgumentParser& parser) override {
53 return parser.RequireArgs({"room"});
54 }
55
56 absl::Status Execute(Rom* rom, const resources::ArgumentParser& parser,
57 resources::OutputFormatter& formatter) override;
58};
59
66 public:
67 std::string GetName() const override { return "dungeon-place-object"; }
68 std::string GetDescription() const {
69 return "Place a dungeon object in a room";
70 }
71 std::string GetUsage() const override {
72 return "dungeon-place-object --room <hex> --id <hex> --x <int> --y <int> "
73 "[--size <int>] [--layer <0|1|2>] "
74 "[--manifest <path>] "
75 "[--write] [--format <json|text>]";
76 }
77
78 absl::Status ValidateArgs(const resources::ArgumentParser& parser) override {
79 return parser.RequireArgs({"room", "id", "x", "y"});
80 }
81
82 absl::Status Execute(Rom* rom, const resources::ArgumentParser& parser,
83 resources::OutputFormatter& formatter) override;
84};
85
94 public:
95 std::string GetName() const override { return "dungeon-get-palette"; }
96 std::string GetDescription() const {
97 return "Inspect a room's resolved shared dungeon palette in a US/OOS ROM";
98 }
99 std::string GetUsage() const override {
100 return "dungeon-get-palette --room <hex> [--index <0..89>] "
101 "[--format <json|text>]";
102 }
103
104 absl::Status ValidateArgs(const resources::ArgumentParser& parser) override {
105 return parser.RequireArgs({"room"});
106 }
107
108 absl::Status Execute(Rom* rom, const resources::ArgumentParser& parser,
109 resources::OutputFormatter& formatter) override;
110};
111
119 public:
120 std::string GetName() const override { return "dungeon-set-palette-color"; }
121 std::string GetDescription() const {
122 return "Change one US/OOS shared dungeon palette color with safety guards";
123 }
124 std::string GetUsage() const override {
125 return "dungeon-set-palette-color --room <hex> --index <0..89> "
126 "--expect-palette-set <hex> --expect-palette-index <0..19> "
127 "--expect-color <hex> --color <hex> --manifest <path> "
128 "[--write] [--format <json|text>]";
129 }
130
131 absl::Status ValidateArgs(const resources::ArgumentParser& parser) override {
132 return parser.RequireArgs({"room", "index", "expect-palette-set",
133 "expect-palette-index", "expect-color", "color",
134 "manifest"});
135 }
136
137 absl::Status Execute(Rom* rom, const resources::ArgumentParser& parser,
138 resources::OutputFormatter& formatter) override;
139};
140
148 public:
149 std::string GetName() const override { return "dungeon-set-door-type"; }
150 std::string GetDescription() const {
151 return "Change an existing dungeon door type";
152 }
153 std::string GetUsage() const override {
154 return "dungeon-set-door-type --room <hex> --x <int> --y <int> "
155 "--type <hex> --expect-type <hex> --manifest <path> "
156 "[--write] [--format <json|text>]";
157 }
158
159 absl::Status ValidateArgs(const resources::ArgumentParser& parser) override {
160 return parser.RequireArgs(
161 {"room", "x", "y", "type", "expect-type", "manifest"});
162 }
163
164 absl::Status Execute(Rom* rom, const resources::ArgumentParser& parser,
165 resources::OutputFormatter& formatter) override;
166};
167
172 public:
173 std::string GetName() const override { return "dungeon-list-pot-items"; }
174 std::string GetDescription() const {
175 return "List existing dungeon pot-item entries";
176 }
177 std::string GetUsage() const override {
178 return "dungeon-list-pot-items --room <hex> "
179 "[--format <json|text>]";
180 }
181
182 absl::Status ValidateArgs(const resources::ArgumentParser& parser) override {
183 return parser.RequireArgs({"room"});
184 }
185
186 absl::Status Execute(Rom* rom, const resources::ArgumentParser& parser,
187 resources::OutputFormatter& formatter) override;
188};
189
197 public:
198 std::string GetName() const override { return "dungeon-set-pot-item"; }
199 std::string GetDescription() const {
200 return "Change an existing dungeon pot item";
201 }
202 std::string GetUsage() const override {
203 return "dungeon-set-pot-item --room <hex> --index <int> "
204 "--expect-position <hex> --expect-item <hex> --item <hex> "
205 "--manifest <path> [--write] [--format <json|text>]";
206 }
207
208 absl::Status ValidateArgs(const resources::ArgumentParser& parser) override {
209 return parser.RequireArgs({"room", "index", "expect-position",
210 "expect-item", "item", "manifest"});
211 }
212
213 absl::Status Execute(Rom* rom, const resources::ArgumentParser& parser,
214 resources::OutputFormatter& formatter) override;
215};
216
224 public:
225 std::string GetName() const override { return "dungeon-set-collision-tile"; }
226 std::string GetDescription() const {
227 return "Set custom collision tiles in a dungeon room";
228 }
229 std::string GetUsage() const override {
230 return "dungeon-set-collision-tile --room <hex> "
231 "--tiles <x,y,tile>[;<x,y,tile>...] "
232 "[--write] [--format <json|text>]";
233 }
234
235 absl::Status ValidateArgs(const resources::ArgumentParser& parser) override {
236 return parser.RequireArgs({"room", "tiles"});
237 }
238
239 absl::Status Execute(Rom* rom, const resources::ArgumentParser& parser,
240 resources::OutputFormatter& formatter) override;
241};
242
243} // namespace handlers
244} // namespace cli
245} // namespace yaze
246
247#endif // YAZE_SRC_CLI_HANDLERS_GAME_DUNGEON_EDIT_COMMANDS_H_
The Rom class is used to load, save, and modify Rom data. This is a generic SNES ROM container and do...
Definition rom.h:28
Resolve and inspect the shared dungeon palette used by one room.
std::string GetUsage() const override
Get the command usage string.
absl::Status ValidateArgs(const resources::ArgumentParser &parser) override
Validate command arguments.
absl::Status Execute(Rom *rom, const resources::ArgumentParser &parser, resources::OutputFormatter &formatter) override
Execute the command business logic.
std::string GetName() const override
Get the command name.
List existing pot-item entries and their exact ROM addresses.
absl::Status Execute(Rom *rom, const resources::ArgumentParser &parser, resources::OutputFormatter &formatter) override
Execute the command business logic.
std::string GetUsage() const override
Get the command usage string.
absl::Status ValidateArgs(const resources::ArgumentParser &parser) override
Validate command arguments.
std::string GetName() const override
Get the command name.
Place a dungeon object (track segment, door, etc.) in a room.
absl::Status ValidateArgs(const resources::ArgumentParser &parser) override
Validate command arguments.
absl::Status Execute(Rom *rom, const resources::ArgumentParser &parser, resources::OutputFormatter &formatter) override
Execute the command business logic.
std::string GetUsage() const override
Get the command usage string.
std::string GetName() const override
Get the command name.
Place a sprite in a dungeon room and optionally write to ROM.
absl::Status ValidateArgs(const resources::ArgumentParser &parser) override
Validate command arguments.
std::string GetName() const override
Get the command name.
std::string GetUsage() const override
Get the command usage string.
absl::Status Execute(Rom *rom, const resources::ArgumentParser &parser, resources::OutputFormatter &formatter) override
Execute the command business logic.
Remove a sprite from a dungeon room by index or position.
std::string GetName() const override
Get the command name.
std::string GetUsage() const override
Get the command usage string.
absl::Status ValidateArgs(const resources::ArgumentParser &parser) override
Validate command arguments.
absl::Status Execute(Rom *rom, const resources::ArgumentParser &parser, resources::OutputFormatter &formatter) override
Execute the command business logic.
Set individual custom collision tiles in a dungeon room.
std::string GetName() const override
Get the command name.
std::string GetUsage() const override
Get the command usage string.
absl::Status ValidateArgs(const resources::ArgumentParser &parser) override
Validate command arguments.
absl::Status Execute(Rom *rom, const resources::ArgumentParser &parser, resources::OutputFormatter &formatter) override
Execute the command business logic.
Change one existing dungeon door's fixed-width type byte.
absl::Status Execute(Rom *rom, const resources::ArgumentParser &parser, resources::OutputFormatter &formatter) override
Execute the command business logic.
std::string GetName() const override
Get the command name.
absl::Status ValidateArgs(const resources::ArgumentParser &parser) override
Validate command arguments.
std::string GetUsage() const override
Get the command usage string.
Change one color in a room's resolved shared dungeon palette.
std::string GetName() const override
Get the command name.
absl::Status Execute(Rom *rom, const resources::ArgumentParser &parser, resources::OutputFormatter &formatter) override
Execute the command business logic.
absl::Status ValidateArgs(const resources::ArgumentParser &parser) override
Validate command arguments.
std::string GetUsage() const override
Get the command usage string.
Change one existing pot item's fixed-width item byte.
absl::Status ValidateArgs(const resources::ArgumentParser &parser) override
Validate command arguments.
std::string GetName() const override
Get the command name.
std::string GetUsage() const override
Get the command usage string.
absl::Status Execute(Rom *rom, const resources::ArgumentParser &parser, resources::OutputFormatter &formatter) override
Execute the command business logic.
Utility for parsing common CLI argument patterns.
absl::Status RequireArgs(const std::vector< std::string > &required) const
Validate that required arguments are present.
Base class for CLI command handlers.
Utility for consistent output formatting across commands.