yaze 0.3.2
Link to the Past ROM Editor
 
Loading...
Searching...
No Matches
Public Member Functions | Private Member Functions | Private Attributes | List of all members
yaze::emu::debug::SemanticIntrospectionEngine Class Reference

Engine for extracting semantic game state from SNES memory. More...

#include <semantic_introspection.h>

Collaboration diagram for yaze::emu::debug::SemanticIntrospectionEngine:
Collaboration graph
[legend]

Public Member Functions

 SemanticIntrospectionEngine (Memory *memory)
 Construct a new Semantic Introspection Engine.
 
 ~SemanticIntrospectionEngine ()=default
 
absl::StatusOr< SemanticGameState > GetSemanticState ()
 Get the complete semantic game state.
 
absl::StatusOr< std::string > GetStateAsJson ()
 Get the semantic state as JSON string.
 
absl::StatusOr< PlayerState > GetPlayerState ()
 Get only the player state.
 
absl::StatusOr< std::vector< SpriteState > > GetSpriteStates ()
 Get all active sprite states.
 
absl::StatusOr< LocationContext > GetLocationContext ()
 Get the current location context.
 
absl::StatusOr< GameModeState > GetGameModeState ()
 Get the current game mode state.
 

Private Member Functions

std::string GetGameModeName (uint8_t mode, uint8_t submodule)
 
std::string GetPlayerStateName (uint8_t state)
 
std::string GetPlayerDirectionName (uint8_t direction)
 
std::string GetSpriteTypeName (uint8_t type)
 
std::string GetSpriteStateName (uint8_t state)
 
std::string GetOverworldAreaName (uint8_t area)
 
std::string GetDungeonRoomName (uint16_t room)
 

Private Attributes

Memory * memory_
 

Detailed Description

Engine for extracting semantic game state from SNES memory.

This class provides high-level semantic interpretations of raw SNES RAM values, making it easier for AI agents to understand the game state without needing to know the specific memory addresses or value encodings.

Definition at line 127 of file semantic_introspection.h.

Constructor & Destructor Documentation

◆ SemanticIntrospectionEngine()

yaze::emu::debug::SemanticIntrospectionEngine::SemanticIntrospectionEngine ( Memory * memory)
explicit

Construct a new Semantic Introspection Engine.

Parameters
memoryPointer to the SNES memory interface

Definition at line 14 of file semantic_introspection.cc.

References memory_.

◆ ~SemanticIntrospectionEngine()

yaze::emu::debug::SemanticIntrospectionEngine::~SemanticIntrospectionEngine ( )
default

Member Function Documentation

◆ GetSemanticState()

absl::StatusOr< SemanticGameState > yaze::emu::debug::SemanticIntrospectionEngine::GetSemanticState ( )

Get the complete semantic game state.

Returns
Current semantic game state
Todo
Implement lag frame detection

Definition at line 21 of file semantic_introspection.cc.

References yaze::emu::debug::SemanticGameState::frame, yaze::emu::debug::FrameInfo::frame_counter, yaze::emu::debug::SemanticGameState::game_mode, GetGameModeState(), GetLocationContext(), GetPlayerState(), GetSpriteStates(), yaze::emu::debug::FrameInfo::is_lag_frame, yaze::emu::debug::alttp::kFrameCounter, yaze::emu::debug::SemanticGameState::location, memory_, yaze::emu::debug::SemanticGameState::player, yaze::emu::Memory::ReadByte(), and yaze::emu::debug::SemanticGameState::sprites.

Referenced by GetStateAsJson().

◆ GetStateAsJson()

absl::StatusOr< std::string > yaze::emu::debug::SemanticIntrospectionEngine::GetStateAsJson ( )

Get the semantic state as JSON string.

Returns
JSON representation of the current game state

Definition at line 63 of file semantic_introspection.cc.

References GetSemanticState().

Here is the call graph for this function:

◆ GetPlayerState()

absl::StatusOr< PlayerState > yaze::emu::debug::SemanticIntrospectionEngine::GetPlayerState ( )

Get only the player state.

Returns
Current player semantic state

Definition at line 116 of file semantic_introspection.cc.

References yaze::emu::debug::PlayerState::direction, yaze::emu::debug::PlayerState::direction_name, GetPlayerDirectionName(), GetPlayerStateName(), yaze::emu::debug::PlayerState::health, yaze::emu::debug::alttp::kLinkDirection, yaze::emu::debug::alttp::kLinkHealth, yaze::emu::debug::alttp::kLinkLayer, yaze::emu::debug::alttp::kLinkMaxHealth, yaze::emu::debug::alttp::kLinkState, yaze::emu::debug::alttp::kLinkXHigh, yaze::emu::debug::alttp::kLinkXLow, yaze::emu::debug::alttp::kLinkYHigh, yaze::emu::debug::alttp::kLinkYLow, yaze::emu::debug::PlayerState::layer, yaze::emu::debug::PlayerState::max_health, memory_, yaze::emu::Memory::ReadByte(), yaze::emu::debug::PlayerState::state, yaze::emu::debug::PlayerState::state_name, yaze::emu::debug::PlayerState::x, and yaze::emu::debug::PlayerState::y.

Referenced by GetSemanticState().

Here is the call graph for this function:

◆ GetSpriteStates()

absl::StatusOr< std::vector< SpriteState > > yaze::emu::debug::SemanticIntrospectionEngine::GetSpriteStates ( )

Get all active sprite states.

Returns
Vector of active sprite states

Definition at line 150 of file semantic_introspection.cc.

References GetSpriteStateName(), GetSpriteTypeName(), yaze::emu::debug::SpriteState::id, yaze::emu::debug::alttp::kSpriteState, yaze::emu::debug::alttp::kSpriteType, yaze::emu::debug::alttp::kSpriteXHigh, yaze::emu::debug::alttp::kSpriteXLow, yaze::emu::debug::alttp::kSpriteYHigh, yaze::emu::debug::alttp::kSpriteYLow, memory_, yaze::emu::Memory::ReadByte(), yaze::emu::debug::SpriteState::state, yaze::emu::debug::SpriteState::state_name, yaze::emu::debug::SpriteState::type, yaze::emu::debug::SpriteState::type_name, yaze::emu::debug::SpriteState::x, and yaze::emu::debug::SpriteState::y.

Referenced by GetSemanticState().

Here is the call graph for this function:

◆ GetLocationContext()

absl::StatusOr< LocationContext > yaze::emu::debug::SemanticIntrospectionEngine::GetLocationContext ( )

Get the current location context.

Returns
Current location semantic state

Definition at line 190 of file semantic_introspection.cc.

References yaze::emu::debug::LocationContext::area_name, yaze::emu::debug::LocationContext::dungeon_room, GetDungeonRoomName(), GetOverworldAreaName(), yaze::emu::debug::LocationContext::indoors, yaze::emu::debug::alttp::kDungeonRoomHigh, yaze::emu::debug::alttp::kDungeonRoomLow, yaze::emu::debug::alttp::kIndoorFlag, yaze::emu::debug::alttp::kOverworldArea, memory_, yaze::emu::debug::LocationContext::overworld_area, yaze::emu::Memory::ReadByte(), and yaze::emu::debug::LocationContext::room_name.

Referenced by GetSemanticState().

Here is the call graph for this function:

◆ GetGameModeState()

absl::StatusOr< GameModeState > yaze::emu::debug::SemanticIntrospectionEngine::GetGameModeState ( )

Get the current game mode state.

Returns
Current game mode semantic state

Definition at line 217 of file semantic_introspection.cc.

References GetGameModeName(), yaze::emu::debug::GameModeState::in_game, yaze::emu::debug::GameModeState::in_transition, yaze::emu::debug::alttp::kGameMode, yaze::emu::debug::alttp::kSubmodule, yaze::emu::debug::GameModeState::main_mode, memory_, yaze::emu::debug::GameModeState::mode_name, yaze::emu::Memory::ReadByte(), and yaze::emu::debug::GameModeState::submodule.

Referenced by GetSemanticState().

Here is the call graph for this function:

◆ GetGameModeName()

std::string yaze::emu::debug::SemanticIntrospectionEngine::GetGameModeName ( uint8_t mode,
uint8_t submodule )
private

Definition at line 240 of file semantic_introspection.cc.

Referenced by GetGameModeState().

◆ GetPlayerStateName()

std::string yaze::emu::debug::SemanticIntrospectionEngine::GetPlayerStateName ( uint8_t state)
private

Definition at line 274 of file semantic_introspection.cc.

Referenced by GetPlayerState().

◆ GetPlayerDirectionName()

std::string yaze::emu::debug::SemanticIntrospectionEngine::GetPlayerDirectionName ( uint8_t direction)
private

Definition at line 304 of file semantic_introspection.cc.

Referenced by GetPlayerState().

◆ GetSpriteTypeName()

std::string yaze::emu::debug::SemanticIntrospectionEngine::GetSpriteTypeName ( uint8_t type)
private

Definition at line 314 of file semantic_introspection.cc.

Referenced by GetSpriteStates().

◆ GetSpriteStateName()

std::string yaze::emu::debug::SemanticIntrospectionEngine::GetSpriteStateName ( uint8_t state)
private

Definition at line 564 of file semantic_introspection.cc.

Referenced by GetSpriteStates().

◆ GetOverworldAreaName()

std::string yaze::emu::debug::SemanticIntrospectionEngine::GetOverworldAreaName ( uint8_t area)
private

Definition at line 583 of file semantic_introspection.cc.

Referenced by GetLocationContext().

◆ GetDungeonRoomName()

std::string yaze::emu::debug::SemanticIntrospectionEngine::GetDungeonRoomName ( uint16_t room)
private

Definition at line 659 of file semantic_introspection.cc.

Referenced by GetLocationContext().

Member Data Documentation

◆ memory_

Memory* yaze::emu::debug::SemanticIntrospectionEngine::memory_
private

Definition at line 173 of file semantic_introspection.h.

Referenced by GetGameModeState(), GetLocationContext(), GetPlayerState(), GetSemanticState(), GetSpriteStates(), and SemanticIntrospectionEngine().

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