yaze 0.3.2
Link to the Past ROM Editor
 
Loading...
Searching...
No Matches
Namespaces | Classes | Enumerations | Functions
yaze::cli::overworld Namespace Reference

Namespaces

namespace  anonymous_namespace{overworld_inspect.cc}
 

Classes

struct  AreaTileLocation
 
struct  EntranceDetails
 
struct  MapSummary
 
struct  OverworldSprite
 
struct  ScreenTileUsage
 
struct  SpriteQuery
 
struct  TileMatch
 
struct  TileSearchOptions
 
struct  TileStatistics
 
struct  TileUsageCount
 
struct  TileUsageQuery
 
struct  TileUsageSummary
 
struct  WarpEntry
 
struct  WarpQuery
 
struct  WorldTileUsage
 

Enumerations

enum class  WarpType { kEntrance , kHole , kExit }
 

Functions

absl::StatusOr< int > ParseNumeric (std::string_view value, int base)
 
absl::StatusOr< int > ParseWorldSpecifier (std::string_view value)
 
absl::StatusOr< int > InferWorldFromMapId (int map_id)
 
std::string WorldName (int world)
 
std::string WarpTypeName (WarpType type)
 
absl::StatusOr< MapSummary > BuildMapSummary (zelda3::Overworld &overworld, int map_id)
 
absl::StatusOr< std::vector< WarpEntry > > CollectWarpEntries (const zelda3::Overworld &overworld, const WarpQuery &query)
 
std::pair< int, int > AreaScreenSpan (const zelda3::OverworldMap &parent_map)
 
absl::StatusOr< AreaTileLocation > ResolveAreaTileLocation (int map_id, int parent_map, int area_columns, int area_rows, int x, int y)
 
absl::StatusOr< AreaTileLocation > ResolveAreaTileForMap (const zelda3::Overworld &overworld, int map_id, int x, int y)
 
absl::StatusOr< AreaTileLocation > LocateScreenTile (const zelda3::Overworld &overworld, int screen_id, int screen_x, int screen_y)
 
absl::StatusOr< uint16_t > ReadAreaTile (zelda3::Overworld &overworld, const AreaTileLocation &location)
 
absl::Status WriteAreaTile (zelda3::Overworld &overworld, const AreaTileLocation &location, uint16_t tile_id)
 
absl::StatusOr< std::vector< TileMatch > > FindTileMatches (zelda3::Overworld &overworld, uint16_t tile_id, const TileSearchOptions &options)
 
const char * SpritePhaseName (int phase)
 
absl::StatusOr< std::vector< OverworldSprite > > CollectOverworldSprites (const zelda3::Overworld &overworld, const SpriteQuery &query)
 
absl::StatusOr< EntranceDetails > GetEntranceDetails (const zelda3::Overworld &overworld, uint8_t entrance_id)
 
absl::StatusOr< TileStatistics > AnalyzeTileUsage (zelda3::Overworld &overworld, uint16_t tile_id, const TileSearchOptions &options)
 
absl::StatusOr< TileUsageSummary > CollectTileUsage (zelda3::Overworld &overworld, const TileUsageQuery &query)
 

Enumeration Type Documentation

◆ WarpType

enum class yaze::cli::overworld::WarpType
strong
Enumerator
kEntrance 
kHole 
kExit 

Definition at line 26 of file overworld_inspect.h.

Function Documentation

◆ ParseNumeric()

absl::StatusOr< int > yaze::cli::overworld::ParseNumeric ( std::string_view value,
int base )

Definition at line 105 of file overworld_inspect.cc.

◆ ParseWorldSpecifier()

absl::StatusOr< int > yaze::cli::overworld::ParseWorldSpecifier ( std::string_view value)

Definition at line 120 of file overworld_inspect.cc.

Referenced by yaze::cli::handlers::OverworldFindTileCommandHandler::Execute(), and yaze::cli::handlers::OverworldTileStatsCommandHandler::Execute().

◆ InferWorldFromMapId()

absl::StatusOr< int > yaze::cli::overworld::InferWorldFromMapId ( int map_id)

Definition at line 135 of file overworld_inspect.cc.

References RETURN_IF_ERROR.

Referenced by AnalyzeTileUsage(), BuildMapSummary(), CollectTileUsage(), yaze::cli::handlers::OverworldListItemsCommandHandler::Execute(), FindTileMatches(), LocateScreenTile(), and ResolveAreaTileLocation().

◆ WorldName()

std::string yaze::cli::overworld::WorldName ( int world)

Definition at line 146 of file overworld_inspect.cc.

Referenced by yaze::cli::handlers::anonymous_namespace{overworld_commands.cc}::AddTileLocationFields(), CollectTileUsage(), yaze::cli::handlers::OverworldFindTileCommandHandler::Execute(), yaze::cli::handlers::OverworldDescribeMapCommandHandler::Execute(), yaze::cli::handlers::OverworldListWarpsCommandHandler::Execute(), yaze::cli::handlers::OverworldListSpritesCommandHandler::Execute(), yaze::cli::handlers::OverworldListItemsCommandHandler::Execute(), yaze::cli::handlers::OverworldGetEntranceCommandHandler::Execute(), yaze::cli::handlers::OverworldTileStatsCommandHandler::Execute(), FindTileMatches(), ResolveAreaTileLocation(), and yaze::cli::handlers::anonymous_namespace{overworld_commands.cc}::VerifyTileGridRoundTrip().

◆ WarpTypeName()

std::string yaze::cli::overworld::WarpTypeName ( WarpType type)

Definition at line 159 of file overworld_inspect.cc.

References kEntrance, kExit, and kHole.

Referenced by yaze::cli::handlers::OverworldListWarpsCommandHandler::Execute().

◆ BuildMapSummary()

absl::StatusOr< MapSummary > yaze::cli::overworld::BuildMapSummary ( zelda3::Overworld & overworld,
int map_id )

Definition at line 172 of file overworld_inspect.cc.

References yaze::cli::overworld::MapSummary::animated_gfx, yaze::cli::overworld::MapSummary::area_graphics, yaze::cli::overworld::MapSummary::area_music, yaze::cli::overworld::MapSummary::area_palette, yaze::cli::overworld::MapSummary::area_size, yaze::cli::overworld::MapSummary::area_specific_bg_color, ASSIGN_OR_RETURN, yaze::zelda3::Overworld::EnsureMapBuilt(), yaze::cli::overworld::MapSummary::has_overlay, InferWorldFromMapId(), yaze::cli::overworld::MapSummary::is_large_map, yaze::cli::overworld::MapSummary::large_quadrant, yaze::cli::overworld::MapSummary::local_index, yaze::cli::overworld::MapSummary::main_palette, yaze::cli::overworld::MapSummary::map_id, yaze::cli::overworld::MapSummary::map_x, yaze::cli::overworld::MapSummary::map_y, yaze::cli::overworld::MapSummary::message_id, yaze::cli::overworld::MapSummary::overlay_id, yaze::zelda3::Overworld::overworld_map(), yaze::cli::overworld::MapSummary::parent_map, RETURN_IF_ERROR, yaze::cli::overworld::MapSummary::sprite_graphics, yaze::cli::overworld::MapSummary::sprite_palettes, yaze::cli::overworld::MapSummary::static_graphics, yaze::cli::overworld::MapSummary::subscreen_overlay, and yaze::cli::overworld::MapSummary::world.

Referenced by yaze::cli::handlers::OverworldDescribeMapCommandHandler::Execute().

Here is the call graph for this function:

◆ CollectWarpEntries()

absl::StatusOr< std::vector< WarpEntry > > yaze::cli::overworld::CollectWarpEntries ( const zelda3::Overworld & overworld,
const WarpQuery & query )

Definition at line 228 of file overworld_inspect.cc.

References yaze::cli::overworld::WarpEntry::deleted, yaze::cli::overworld::WarpEntry::entrance_id, yaze::cli::overworld::WarpEntry::entrance_name, yaze::zelda3::Overworld::entrances(), yaze::zelda3::Overworld::holes(), yaze::cli::overworld::WarpEntry::is_hole, kEntrance, kHole, yaze::cli::overworld::WarpEntry::map_id, yaze::cli::overworld::WarpQuery::map_id, yaze::cli::overworld::WarpEntry::tile16_x, yaze::cli::overworld::WarpEntry::tile16_y, yaze::cli::overworld::WarpEntry::type, yaze::cli::overworld::WarpQuery::type, yaze::cli::overworld::WarpEntry::world, and yaze::cli::overworld::WarpQuery::world.

Referenced by yaze::cli::handlers::OverworldListWarpsCommandHandler::Execute().

Here is the call graph for this function:

◆ AreaScreenSpan()

std::pair< int, int > yaze::cli::overworld::AreaScreenSpan ( const zelda3::OverworldMap & parent_map)

Definition at line 300 of file overworld_inspect.cc.

References yaze::zelda3::OverworldMap::area_size(), AreaScreenSpan(), yaze::zelda3::OverworldMap::is_large_map(), yaze::zelda3::LargeArea, yaze::zelda3::TallArea, and yaze::zelda3::WideArea.

Referenced by AreaScreenSpan(), yaze::cli::handlers::OverworldDescribeMapCommandHandler::Execute(), and ResolveAreaTileForMap().

Here is the call graph for this function:

◆ ResolveAreaTileLocation()

absl::StatusOr< AreaTileLocation > yaze::cli::overworld::ResolveAreaTileLocation ( int map_id,
int parent_map,
int area_columns,
int area_rows,
int x,
int y )

Definition at line 315 of file overworld_inspect.cc.

References yaze::cli::overworld::AreaTileLocation::area_height, yaze::cli::overworld::AreaTileLocation::area_width, yaze::cli::overworld::AreaTileLocation::area_x, yaze::cli::overworld::AreaTileLocation::area_y, ASSIGN_OR_RETURN, InferWorldFromMapId(), yaze::cli::overworld::AreaTileLocation::map_id, yaze::cli::overworld::AreaTileLocation::parent_map, ResolveAreaTileLocation(), RETURN_IF_ERROR, yaze::cli::overworld::AreaTileLocation::screen_id, yaze::cli::overworld::AreaTileLocation::screen_x, yaze::cli::overworld::AreaTileLocation::screen_y, yaze::cli::overworld::AreaTileLocation::world, yaze::cli::overworld::AreaTileLocation::world_x, yaze::cli::overworld::AreaTileLocation::world_y, and WorldName().

Referenced by ResolveAreaTileForMap(), and ResolveAreaTileLocation().

Here is the call graph for this function:

◆ ResolveAreaTileForMap()

absl::StatusOr< AreaTileLocation > yaze::cli::overworld::ResolveAreaTileForMap ( const zelda3::Overworld & overworld,
int map_id,
int x,
int y )

Definition at line 379 of file overworld_inspect.cc.

References AreaScreenSpan(), yaze::zelda3::Overworld::overworld_map(), ResolveAreaTileForMap(), ResolveAreaTileLocation(), and RETURN_IF_ERROR.

Referenced by yaze::cli::handlers::OverworldGetTileCommandHandler::Execute(), yaze::cli::handlers::OverworldSetTileCommandHandler::ExecuteWithContext(), LocateScreenTile(), and ResolveAreaTileForMap().

Here is the call graph for this function:

◆ LocateScreenTile()

absl::StatusOr< AreaTileLocation > yaze::cli::overworld::LocateScreenTile ( const zelda3::Overworld & overworld,
int screen_id,
int screen_x,
int screen_y )

Definition at line 398 of file overworld_inspect.cc.

References ASSIGN_OR_RETURN, InferWorldFromMapId(), LocateScreenTile(), yaze::zelda3::Overworld::overworld_map(), ResolveAreaTileForMap(), and RETURN_IF_ERROR.

Referenced by yaze::cli::handlers::OverworldFindTileCommandHandler::Execute(), and LocateScreenTile().

Here is the call graph for this function:

◆ ReadAreaTile()

absl::StatusOr< uint16_t > yaze::cli::overworld::ReadAreaTile ( zelda3::Overworld & overworld,
const AreaTileLocation & location )

Definition at line 421 of file overworld_inspect.cc.

References yaze::zelda3::Overworld::GetMapTiles(), ReadAreaTile(), yaze::cli::overworld::AreaTileLocation::world, yaze::cli::overworld::AreaTileLocation::world_x, and yaze::cli::overworld::AreaTileLocation::world_y.

Referenced by yaze::cli::handlers::anonymous_namespace{overworld_commands.cc}::ApplyTileEdit(), yaze::cli::handlers::OverworldGetTileCommandHandler::Execute(), yaze::cli::handlers::OverworldSetTileCommandHandler::ExecuteWithContext(), ReadAreaTile(), and WriteAreaTile().

Here is the call graph for this function:

◆ WriteAreaTile()

absl::Status yaze::cli::overworld::WriteAreaTile ( zelda3::Overworld & overworld,
const AreaTileLocation & location,
uint16_t tile_id )

Definition at line 434 of file overworld_inspect.cc.

References yaze::zelda3::Overworld::GetMapTiles(), ReadAreaTile(), RETURN_IF_ERROR, yaze::cli::overworld::AreaTileLocation::world, yaze::cli::overworld::AreaTileLocation::world_x, yaze::cli::overworld::AreaTileLocation::world_y, and WriteAreaTile().

Referenced by yaze::cli::handlers::anonymous_namespace{overworld_commands.cc}::ApplyTileEdit(), and WriteAreaTile().

Here is the call graph for this function:

◆ FindTileMatches()

absl::StatusOr< std::vector< TileMatch > > yaze::cli::overworld::FindTileMatches ( zelda3::Overworld & overworld,
uint16_t tile_id,
const TileSearchOptions & options )

Definition at line 442 of file overworld_inspect.cc.

References ASSIGN_OR_RETURN, FindTileMatches(), yaze::zelda3::Overworld::GetTile(), InferWorldFromMapId(), yaze::cli::overworld::TileSearchOptions::map_id, RETURN_IF_ERROR, yaze::zelda3::Overworld::set_current_world(), yaze::cli::overworld::TileSearchOptions::world, and WorldName().

Referenced by AnalyzeTileUsage(), yaze::cli::handlers::OverworldFindTileCommandHandler::Execute(), and FindTileMatches().

◆ SpritePhaseName()

const char * yaze::cli::overworld::SpritePhaseName ( int phase)

Definition at line 530 of file overworld_inspect.cc.

References SpritePhaseName().

Referenced by yaze::cli::handlers::OverworldListSpritesCommandHandler::Execute(), yaze::cli::handlers::OverworldSpriteEditCommandHandler::ExecuteWithContext(), and SpritePhaseName().

Here is the call graph for this function:

◆ CollectOverworldSprites()

absl::StatusOr< std::vector< OverworldSprite > > yaze::cli::overworld::CollectOverworldSprites ( const zelda3::Overworld & overworld,
const SpriteQuery & query )

Definition at line 542 of file overworld_inspect.cc.

References CollectOverworldSprites(), yaze::cli::overworld::OverworldSprite::list_index, yaze::cli::overworld::OverworldSprite::local_x, yaze::cli::overworld::OverworldSprite::local_y, yaze::cli::overworld::OverworldSprite::map_id, yaze::cli::overworld::SpriteQuery::map_id, yaze::cli::overworld::OverworldSprite::phase, yaze::cli::overworld::SpriteQuery::phase, yaze::zelda3::ResolveSpriteName(), yaze::cli::overworld::OverworldSprite::sprite_id, yaze::cli::overworld::SpriteQuery::sprite_id, yaze::cli::overworld::OverworldSprite::sprite_name, yaze::zelda3::Overworld::sprites(), yaze::cli::overworld::OverworldSprite::world, yaze::cli::overworld::SpriteQuery::world, yaze::cli::overworld::OverworldSprite::x, and yaze::cli::overworld::OverworldSprite::y.

Referenced by CollectOverworldSprites(), and yaze::cli::handlers::OverworldListSpritesCommandHandler::Execute().

Here is the call graph for this function:

◆ GetEntranceDetails()

absl::StatusOr< EntranceDetails > yaze::cli::overworld::GetEntranceDetails ( const zelda3::Overworld & overworld,
uint8_t entrance_id )

Definition at line 594 of file overworld_inspect.cc.

References yaze::cli::overworld::EntranceDetails::area_x, yaze::cli::overworld::EntranceDetails::area_y, yaze::cli::overworld::EntranceDetails::entrance_id, yaze::cli::overworld::EntranceDetails::entrance_name, yaze::zelda3::Overworld::entrances(), GetEntranceDetails(), yaze::cli::overworld::EntranceDetails::is_hole, yaze::cli::overworld::EntranceDetails::map_id, yaze::cli::overworld::EntranceDetails::map_pos, yaze::cli::overworld::EntranceDetails::world, yaze::cli::overworld::EntranceDetails::x, and yaze::cli::overworld::EntranceDetails::y.

Referenced by yaze::cli::handlers::OverworldGetEntranceCommandHandler::Execute(), and GetEntranceDetails().

Here is the call graph for this function:

◆ AnalyzeTileUsage()

absl::StatusOr< TileStatistics > yaze::cli::overworld::AnalyzeTileUsage ( zelda3::Overworld & overworld,
uint16_t tile_id,
const TileSearchOptions & options )

Definition at line 627 of file overworld_inspect.cc.

References AnalyzeTileUsage(), ASSIGN_OR_RETURN, yaze::cli::overworld::TileStatistics::count, FindTileMatches(), InferWorldFromMapId(), yaze::cli::overworld::TileSearchOptions::map_id, yaze::cli::overworld::TileStatistics::map_id, yaze::cli::overworld::TileStatistics::positions, yaze::cli::overworld::TileStatistics::tile_id, yaze::cli::overworld::TileSearchOptions::world, and yaze::cli::overworld::TileStatistics::world.

Referenced by AnalyzeTileUsage().

Here is the call graph for this function:

◆ CollectTileUsage()

absl::StatusOr< TileUsageSummary > yaze::cli::overworld::CollectTileUsage ( zelda3::Overworld & overworld,
const TileUsageQuery & query )

Definition at line 659 of file overworld_inspect.cc.

References ASSIGN_OR_RETURN, CollectTileUsage(), yaze::zelda3::Overworld::GetMapTiles(), InferWorldFromMapId(), yaze::cli::overworld::ScreenTileUsage::map_id, yaze::cli::overworld::TileUsageQuery::map_id, yaze::zelda3::Overworld::overworld_map(), yaze::cli::overworld::ScreenTileUsage::parent_map, yaze::cli::overworld::WorldTileUsage::screens, yaze::cli::overworld::TileUsageSummary::screens, yaze::cli::overworld::TileUsageSummary::screens_scanned, yaze::cli::overworld::ScreenTileUsage::tile_count, yaze::cli::overworld::TileUsageQuery::tile_id, yaze::cli::overworld::TileUsageSummary::tiles, yaze::cli::overworld::ScreenTileUsage::top_tile, yaze::cli::overworld::ScreenTileUsage::top_tile_count, yaze::cli::overworld::ScreenTileUsage::total_tiles, yaze::cli::overworld::WorldTileUsage::total_tiles, yaze::cli::overworld::TileUsageSummary::total_tiles, yaze::cli::overworld::ScreenTileUsage::unique_tiles, yaze::cli::overworld::WorldTileUsage::unique_tiles, yaze::cli::overworld::ScreenTileUsage::world, yaze::cli::overworld::WorldTileUsage::world, yaze::cli::overworld::TileUsageQuery::world, WorldName(), and yaze::cli::overworld::TileUsageSummary::worlds.

Referenced by CollectTileUsage(), and yaze::cli::handlers::OverworldTileStatsCommandHandler::Execute().