yaze::cli::handlers::DungeonExportCustomCollisionJsonCommandHandler Class Reference

#include <dungeon_collision_commands.h>

Inheritance diagram for yaze::cli::handlers::DungeonExportCustomCollisionJsonCommandHandler:

Collaboration diagram for yaze::cli::handlers::DungeonExportCustomCollisionJsonCommandHandler:

Public Member Functions
std::string	GetName () const override
	Get the command name.
std::string	GetDescription () const
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.
absl::Status	ExecuteWithContext (Rom *rom, const resources::ArgumentParser &parser, resources::OutputFormatter &formatter, const resources::CommandInvocationContext &invocation_context) override
	Execute with immutable, invocation-scoped ROM path identity.
Public Member Functions inherited from yaze::cli::resources::CommandHandler
virtual	~CommandHandler ()=default
absl::Status	Run (const std::vector< std::string > &args, Rom *rom_context, std::string *captured_output=nullptr)
	Execute the command.
virtual Descriptor	Describe () const
	Provide metadata for TUI/help summaries.
virtual bool	RequiresRom () const
	Check if the command requires a loaded ROM.
virtual bool	RequiresLabels () const
	Check if the command requires ROM labels.
virtual void	SetProjectContext (project::YazeProject *project)
	Set the YazeProject context. Default implementation does nothing, override if tool needs project info.
virtual void	SetAsarWrapper (core::AsarWrapper *asar_wrapper)
	Set the AsarWrapper context. Default implementation does nothing, override if tool needs Asar access.
virtual void	SetRomContext (Rom *rom)
	Set the ROM context for tools that need ROM access. Default implementation stores the ROM pointer for subclass use.
virtual void	SetAssemblySymbolTable (const std::map< std::string, core::AsarSymbol > *table)
	Optional Asar symbol table for assembly-aware tools.
virtual void	SetSymbolProvider (emu::debug::SymbolProvider *provider)
	Set the SymbolProvider context.

Additional Inherited Members
Protected Member Functions inherited from yaze::cli::resources::CommandHandler
virtual std::string	GetDefaultFormat () const
	Get the default output format ("json" or "text")
virtual std::string	GetOutputTitle () const
	Get the output title for formatting.
Protected Attributes inherited from yaze::cli::resources::CommandHandler
Rom *	rom_ = nullptr
emu::debug::SymbolProvider *	symbol_provider_ = nullptr
project::YazeProject *	project_ = nullptr
core::AsarWrapper *	asar_wrapper_ = nullptr
const std::map< std::string, core::AsarSymbol > *	assembly_symbol_table_

Detailed Description

Definition at line 32 of file dungeon_collision_commands.h.

Member Function Documentation

GetName()

std::string yaze::cli::handlers::DungeonExportCustomCollisionJsonCommandHandler::GetName ( ) const

inlineoverridevirtual

Get the command name.

Override this to provide a unique identifier for the command. This is used for command registration and lookup.

Implements yaze::cli::resources::CommandHandler.

Definition at line 35 of file dungeon_collision_commands.h.

Referenced by ExecuteWithContext(), and ValidateArgs().

GetDescription()

std::string yaze::cli::handlers::DungeonExportCustomCollisionJsonCommandHandler::GetDescription ( ) const

inline

Definition at line 38 of file dungeon_collision_commands.h.

GetUsage()

std::string yaze::cli::handlers::DungeonExportCustomCollisionJsonCommandHandler::GetUsage ( ) const

inlineoverridevirtual

Get the command usage string.

Implements yaze::cli::resources::CommandHandler.

Definition at line 41 of file dungeon_collision_commands.h.

ValidateArgs()

absl::Status yaze::cli::handlers::DungeonExportCustomCollisionJsonCommandHandler::ValidateArgs ( const resources::ArgumentParser & parser )

overridevirtual

Validate command arguments.

Implements yaze::cli::resources::CommandHandler.

Definition at line 1510 of file dungeon_collision_commands.cc.

References GetName().

Here is the call graph for this function:

Execute()

absl::Status yaze::cli::handlers::DungeonExportCustomCollisionJsonCommandHandler::Execute ( Rom * rom, const resources::ArgumentParser & parser, resources::OutputFormatter & formatter )

overridevirtual

Execute the command business logic.

Override this to implement command-specific functionality. The ROM is guaranteed to be loaded and labels initialized.

Implements yaze::cli::resources::CommandHandler.

Definition at line 1056 of file dungeon_collision_commands.cc.

References yaze::cli::resources::CommandInvocationContext::active_rom_path, ExecuteWithContext(), yaze::Rom::filename(), and yaze::cli::resources::CommandInvocationContext::source_rom_path.

Here is the call graph for this function:

ExecuteWithContext()

absl::Status yaze::cli::handlers::DungeonExportCustomCollisionJsonCommandHandler::ExecuteWithContext ( Rom * rom, const resources::ArgumentParser & parser, resources::OutputFormatter & formatter, const resources::CommandInvocationContext & invocation_context )

overridevirtual

Execute with immutable, invocation-scoped ROM path identity.

Handlers that protect filesystem outputs from aliasing a source or sandbox ROM can override this hook. Existing handlers continue through Execute() without carrying mutable state on singleton handler instances.

Reimplemented from yaze::cli::resources::CommandHandler.

Definition at line 1067 of file dungeon_collision_commands.cc.

References yaze::cli::resources::OutputFormatter::AddField(), ASSIGN_OR_RETURN, yaze::cli::resources::OutputFormatter::BeginObject(), yaze::zelda3::DumpCustomCollisionRoomsToJsonString(), yaze::cli::resources::OutputFormatter::EndObject(), GetName(), yaze::cli::resources::ArgumentParser::GetString(), yaze::zelda3::LoadCustomCollisionMap(), yaze::zelda3::CustomCollisionRoomEntry::room_id, and yaze::zelda3::CustomCollisionRoomEntry::tiles.

Referenced by Execute().

---

The documentation for this class was generated from the following files:

• src/cli/handlers/game/dungeon_collision_commands.h
• src/cli/handlers/game/dungeon_collision_commands.cc