yaze::cli::handlers::EntranceInfoCommandHandler Class Reference

Command handler for reading entrance table data. More...

#include <dungeon_graph_commands.h>

Inheritance diagram for yaze::cli::handlers::EntranceInfoCommandHandler:

Collaboration diagram for yaze::cli::handlers::EntranceInfoCommandHandler:

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.
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	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

Detailed Description

Command handler for reading entrance table data.

Reads the entrance table at ROM address $14813 and returns comprehensive entrance data including room ID, position, camera settings, and dungeon ID. This is an alias for dungeon-get-entrance with a simpler name.

Definition at line 48 of file dungeon_graph_commands.h.

Member Function Documentation

GetName()

std::string yaze::cli::handlers::EntranceInfoCommandHandler::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 50 of file dungeon_graph_commands.h.

GetDescription()

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

inline

Definition at line 51 of file dungeon_graph_commands.h.

GetUsage()

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

inlineoverridevirtual

Get the command usage string.

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

Definition at line 54 of file dungeon_graph_commands.h.

ValidateArgs()

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

inlineoverridevirtual

Validate command arguments.

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

Definition at line 59 of file dungeon_graph_commands.h.

References yaze::cli::resources::ArgumentParser::RequireArgs().

Here is the call graph for this function:

Execute()

absl::Status yaze::cli::handlers::EntranceInfoCommandHandler::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 313 of file dungeon_graph_commands.cc.

References yaze::cli::resources::OutputFormatter::AddField(), yaze::cli::resources::OutputFormatter::BeginObject(), yaze::zelda3::RoomEntrance::blockset_, yaze::zelda3::RoomEntrance::camera_boundary_fe_, yaze::zelda3::RoomEntrance::camera_boundary_fn_, yaze::zelda3::RoomEntrance::camera_boundary_fs_, yaze::zelda3::RoomEntrance::camera_boundary_fw_, yaze::zelda3::RoomEntrance::camera_boundary_qe_, yaze::zelda3::RoomEntrance::camera_boundary_qn_, yaze::zelda3::RoomEntrance::camera_boundary_qs_, yaze::zelda3::RoomEntrance::camera_boundary_qw_, yaze::zelda3::RoomEntrance::camera_trigger_x_, yaze::zelda3::RoomEntrance::camera_trigger_y_, yaze::zelda3::RoomEntrance::camera_x_, yaze::zelda3::RoomEntrance::camera_y_, yaze::zelda3::RoomEntrance::door_, yaze::zelda3::RoomEntrance::dungeon_id_, yaze::cli::resources::OutputFormatter::EndObject(), yaze::zelda3::RoomEntrance::exit_, yaze::zelda3::RoomEntrance::floor_, yaze::cli::resources::ArgumentParser::GetString(), yaze::cli::resources::ArgumentParser::HasFlag(), yaze::zelda3::RoomEntrance::ladder_bg_, yaze::zelda3::RoomEntrance::music_, yaze::zelda3::RoomEntrance::room_, yaze::zelda3::RoomEntrance::scroll_quadrant_, yaze::zelda3::RoomEntrance::scrolling_, yaze::zelda3::RoomEntrance::x_position_, and yaze::zelda3::RoomEntrance::y_position_.

---

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

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