Panel for viewing Oracle of Secrets SRAM variables via Mesen2. More...

#include <sram_viewer_panel.h>

Collaboration diagram for yaze::editor::SramViewerPanel:

[legend]

Public Member Functions
	SramViewerPanel ()

	~SramViewerPanel ()

void	SetProject (project::YazeProject *project)

void	Draw ()

Private Member Functions
void	DrawConnectionHeader ()

bool	IsConnected () const

void	Connect ()

void	ConnectToPath (const std::string &socket_path)

void	Disconnect ()

void	RefreshSocketList ()

void	DrawVariableTable ()

void	DrawGroupHeader (const char *label, uint32_t range_start, uint32_t range_end)

void	DrawVariableRow (const core::SramVariable &var)

void	DrawCrystalBitfield (uint8_t value, uint32_t address)

void	DrawGameStateDropdown (uint8_t value, uint32_t address)

void	RefreshValues ()

void	LoadVariablesFromManifest ()

void	PokeValue (uint32_t address, uint8_t value)

Private Attributes
std::shared_ptr< emu::mesen::MesenSocketClient >	client_

project::YazeProject *	project_ = nullptr

std::vector< core::SramVariable >	variables_

bool	variables_loaded_ = false

std::unordered_map< uint32_t, uint8_t >	current_values_

std::unordered_map< uint32_t, uint8_t >	previous_values_

std::unordered_map< uint32_t, float >	change_timestamps_

bool	auto_refresh_ = true

float	refresh_interval_ = 0.2f

float	time_since_refresh_ = 0.0f

std::string	connection_error_

std::vector< std::string >	socket_paths_

int	selected_socket_index_ = -1

char	socket_path_buffer_ [256] = {}

std::string	status_message_

char	filter_text_ [128] = {}

bool	editing_active_ = false

uint32_t	editing_address_ = 0

int	editing_value_ = 0

bool	story_expanded_ = true

bool	dungeon_expanded_ = true

bool	items_expanded_ = true

Detailed Description

Panel for viewing Oracle of Secrets SRAM variables via Mesen2.

Reads SRAM variable definitions from the hack manifest and displays their live values from a running Mesen2 emulator. Supports auto-refresh, value editing (poke), bitfield expansion for key addresses (Crystals, GameState), and change highlighting.

Variable grouping:

Story ($7EF3C5-$7EF3D7): GameState, OOSPROG, etc.
Dungeon ($7EF374, $7EF37A): Pendants, Crystals
Items ($7EF340-$7EF37F): Equipment and item counts

Definition at line 33 of file sram_viewer_panel.h.

Constructor & Destructor Documentation

◆ SramViewerPanel()

yaze::editor::SramViewerPanel::SramViewerPanel ( )

Definition at line 69 of file sram_viewer_panel.cc.

References client_, yaze::emu::mesen::MesenClientRegistry::GetOrCreate(), RefreshSocketList(), selected_socket_index_, socket_path_buffer_, and socket_paths_.

Here is the call graph for this function:

◆ ~SramViewerPanel()

yaze::editor::SramViewerPanel::~SramViewerPanel ( )

default

Member Function Documentation

◆ SetProject()

void yaze::editor::SramViewerPanel::SetProject ( project::YazeProject * project )

inline

Definition at line 38 of file sram_viewer_panel.h.

References project_.

◆ Draw()

void yaze::editor::SramViewerPanel::Draw ( )

Definition at line 192 of file sram_viewer_panel.cc.

References auto_refresh_, DrawConnectionHeader(), DrawVariableTable(), filter_text_, IsConnected(), LoadVariablesFromManifest(), yaze::editor::AgentUI::PopPanelStyle(), project_, yaze::editor::AgentUI::PushPanelStyle(), refresh_interval_, RefreshSocketList(), RefreshValues(), time_since_refresh_, variables_, and variables_loaded_.

◆ DrawConnectionHeader()

void yaze::editor::SramViewerPanel::DrawConnectionHeader ( )

private

Definition at line 249 of file sram_viewer_panel.cc.

References auto_refresh_, Connect(), connection_error_, ConnectToPath(), Disconnect(), yaze::editor::AgentUI::GetTheme(), ICON_MD_AUTO_MODE, ICON_MD_CHECK_CIRCLE, ICON_MD_ERROR, ICON_MD_LINK, ICON_MD_LINK_OFF, ICON_MD_MEMORY, ICON_MD_REFRESH, IsConnected(), refresh_interval_, RefreshSocketList(), RefreshValues(), selected_socket_index_, socket_path_buffer_, socket_paths_, and status_message_.

Referenced by Draw().

◆ IsConnected()

bool yaze::editor::SramViewerPanel::IsConnected ( ) const

private

Definition at line 81 of file sram_viewer_panel.cc.

References client_.

Referenced by Draw(), DrawConnectionHeader(), PokeValue(), and RefreshValues().

◆ Connect()

void yaze::editor::SramViewerPanel::Connect ( )

private

Definition at line 85 of file sram_viewer_panel.cc.

References client_, connection_error_, yaze::emu::mesen::MesenClientRegistry::GetOrCreate(), RefreshValues(), and yaze::emu::mesen::MesenClientRegistry::SetClient().

Referenced by DrawConnectionHeader().

Here is the call graph for this function:

◆ ConnectToPath()

void yaze::editor::SramViewerPanel::ConnectToPath ( const std::string & socket_path )

private

Definition at line 99 of file sram_viewer_panel.cc.

References client_, connection_error_, yaze::emu::mesen::MesenClientRegistry::GetOrCreate(), RefreshValues(), and yaze::emu::mesen::MesenClientRegistry::SetClient().

Referenced by DrawConnectionHeader().

Here is the call graph for this function:

◆ Disconnect()

void yaze::editor::SramViewerPanel::Disconnect ( )

private

Definition at line 113 of file sram_viewer_panel.cc.

References client_.

Referenced by DrawConnectionHeader().

◆ RefreshSocketList()

void yaze::editor::SramViewerPanel::RefreshSocketList ( )

private

Definition at line 119 of file sram_viewer_panel.cc.

References yaze::emu::mesen::MesenSocketClient::ListAvailableSockets(), selected_socket_index_, socket_path_buffer_, and socket_paths_.

Referenced by Draw(), DrawConnectionHeader(), and SramViewerPanel().

Here is the call graph for this function:

◆ DrawVariableTable()

void yaze::editor::SramViewerPanel::DrawVariableTable ( )

private

Definition at line 345 of file sram_viewer_panel.cc.

References DrawVariableRow(), dungeon_expanded_, filter_text_, ICON_MD_AUTO_STORIES, ICON_MD_CASTLE, ICON_MD_INVENTORY_2, ICON_MD_MORE_HORIZ, items_expanded_, story_expanded_, and variables_.

Referenced by Draw().

Here is the call graph for this function:

◆ DrawGroupHeader()

void yaze::editor::SramViewerPanel::DrawGroupHeader	(	const char *	label,
		uint32_t	range_start,
		uint32_t	range_end )

private

◆ DrawVariableRow()

void yaze::editor::SramViewerPanel::DrawVariableRow ( const core::SramVariable & var )

private

Definition at line 455 of file sram_viewer_panel.cc.

References yaze::core::SramVariable::address, change_timestamps_, current_values_, DrawCrystalBitfield(), DrawGameStateDropdown(), editing_active_, editing_address_, editing_value_, yaze::editor::AgentUI::GetTheme(), ICON_MD_EDIT, yaze::core::SramVariable::name, and yaze::core::SramVariable::purpose.

Referenced by DrawVariableTable().

Here is the call graph for this function:

◆ DrawCrystalBitfield()

void yaze::editor::SramViewerPanel::DrawCrystalBitfield	(	uint8_t	value,
		uint32_t	address )

private

Definition at line 536 of file sram_viewer_panel.cc.

References PokeValue().

Referenced by DrawVariableRow().

Here is the call graph for this function:

◆ DrawGameStateDropdown()

void yaze::editor::SramViewerPanel::DrawGameStateDropdown	(	uint8_t	value,
		uint32_t	address )

private

Definition at line 562 of file sram_viewer_panel.cc.

References PokeValue().

Referenced by DrawVariableRow().

Here is the call graph for this function:

◆ RefreshValues()

void yaze::editor::SramViewerPanel::RefreshValues ( )

private

Definition at line 152 of file sram_viewer_panel.cc.

References change_timestamps_, client_, current_values_, IsConnected(), previous_values_, and variables_.

Referenced by Connect(), ConnectToPath(), Draw(), and DrawConnectionHeader().

Here is the call graph for this function:

◆ LoadVariablesFromManifest()

void yaze::editor::SramViewerPanel::LoadVariablesFromManifest ( )

private

Definition at line 135 of file sram_viewer_panel.cc.

References yaze::project::YazeProject::hack_manifest, yaze::core::HackManifest::loaded(), project_, yaze::core::HackManifest::sram_variables(), variables_, and variables_loaded_.

Referenced by Draw().

Here is the call graph for this function:

◆ PokeValue()

void yaze::editor::SramViewerPanel::PokeValue	(	uint32_t	address,
		uint8_t	value )

private

Definition at line 177 of file sram_viewer_panel.cc.

References client_, current_values_, IsConnected(), and status_message_.

Referenced by DrawCrystalBitfield(), and DrawGameStateDropdown().

Here is the call graph for this function:

Member Data Documentation

◆ client_

std::shared_ptr<emu::mesen::MesenSocketClient> yaze::editor::SramViewerPanel::client_

private

Definition at line 67 of file sram_viewer_panel.h.

Referenced by Connect(), ConnectToPath(), Disconnect(), IsConnected(), PokeValue(), RefreshValues(), and SramViewerPanel().

◆ project_

project::YazeProject* yaze::editor::SramViewerPanel::project_ = nullptr

private

Definition at line 70 of file sram_viewer_panel.h.

Referenced by Draw(), LoadVariablesFromManifest(), and SetProject().

◆ variables_

std::vector<core::SramVariable> yaze::editor::SramViewerPanel::variables_

private

Definition at line 73 of file sram_viewer_panel.h.

Referenced by Draw(), DrawVariableTable(), LoadVariablesFromManifest(), and RefreshValues().

◆ variables_loaded_

bool yaze::editor::SramViewerPanel::variables_loaded_ = false

private

Definition at line 74 of file sram_viewer_panel.h.

Referenced by Draw(), and LoadVariablesFromManifest().

◆ current_values_

std::unordered_map<uint32_t, uint8_t> yaze::editor::SramViewerPanel::current_values_

private

Definition at line 77 of file sram_viewer_panel.h.

Referenced by DrawVariableRow(), PokeValue(), and RefreshValues().

◆ previous_values_

std::unordered_map<uint32_t, uint8_t> yaze::editor::SramViewerPanel::previous_values_

private

Definition at line 80 of file sram_viewer_panel.h.

Referenced by RefreshValues().

◆ change_timestamps_

std::unordered_map<uint32_t, float> yaze::editor::SramViewerPanel::change_timestamps_

private

Definition at line 83 of file sram_viewer_panel.h.

Referenced by DrawVariableRow(), and RefreshValues().

◆ auto_refresh_

bool yaze::editor::SramViewerPanel::auto_refresh_ = true

private

Definition at line 86 of file sram_viewer_panel.h.

Referenced by Draw(), and DrawConnectionHeader().

◆ refresh_interval_

float yaze::editor::SramViewerPanel::refresh_interval_ = 0.2f

private

Definition at line 87 of file sram_viewer_panel.h.

Referenced by Draw(), and DrawConnectionHeader().

◆ time_since_refresh_

float yaze::editor::SramViewerPanel::time_since_refresh_ = 0.0f

private

Definition at line 88 of file sram_viewer_panel.h.

Referenced by Draw().

◆ connection_error_

std::string yaze::editor::SramViewerPanel::connection_error_

private

Definition at line 89 of file sram_viewer_panel.h.

Referenced by Connect(), ConnectToPath(), and DrawConnectionHeader().

◆ socket_paths_

std::vector<std::string> yaze::editor::SramViewerPanel::socket_paths_

private

Definition at line 90 of file sram_viewer_panel.h.

Referenced by DrawConnectionHeader(), RefreshSocketList(), and SramViewerPanel().

◆ selected_socket_index_

int yaze::editor::SramViewerPanel::selected_socket_index_ = -1

private

Definition at line 91 of file sram_viewer_panel.h.

Referenced by DrawConnectionHeader(), RefreshSocketList(), and SramViewerPanel().

◆ socket_path_buffer_

char yaze::editor::SramViewerPanel::socket_path_buffer_[256] = {}

private

Definition at line 92 of file sram_viewer_panel.h.

Referenced by DrawConnectionHeader(), RefreshSocketList(), and SramViewerPanel().

◆ status_message_

std::string yaze::editor::SramViewerPanel::status_message_

private

Definition at line 93 of file sram_viewer_panel.h.

Referenced by DrawConnectionHeader(), and PokeValue().

◆ filter_text_

char yaze::editor::SramViewerPanel::filter_text_[128] = {}

private

Definition at line 94 of file sram_viewer_panel.h.

Referenced by Draw(), and DrawVariableTable().

◆ editing_active_

bool yaze::editor::SramViewerPanel::editing_active_ = false

private

Definition at line 97 of file sram_viewer_panel.h.

Referenced by DrawVariableRow().

◆ editing_address_

uint32_t yaze::editor::SramViewerPanel::editing_address_ = 0

private

Definition at line 98 of file sram_viewer_panel.h.

Referenced by DrawVariableRow().

◆ editing_value_

int yaze::editor::SramViewerPanel::editing_value_ = 0

private

Definition at line 99 of file sram_viewer_panel.h.

Referenced by DrawVariableRow().

◆ story_expanded_

bool yaze::editor::SramViewerPanel::story_expanded_ = true

private

Definition at line 102 of file sram_viewer_panel.h.

Referenced by DrawVariableTable().

◆ dungeon_expanded_

bool yaze::editor::SramViewerPanel::dungeon_expanded_ = true

private

Definition at line 103 of file sram_viewer_panel.h.

Referenced by DrawVariableTable().

◆ items_expanded_

bool yaze::editor::SramViewerPanel::items_expanded_ = true

private

Definition at line 104 of file sram_viewer_panel.h.

Referenced by DrawVariableTable().

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

src/app/editor/agent/panels/sram_viewer_panel.h
src/app/editor/agent/panels/sram_viewer_panel.cc

	yaze 0.3.2 Link to the Past ROM Editor

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ SramViewerPanel()

◆ ~SramViewerPanel()

Member Function Documentation

◆ SetProject()

◆ Draw()

◆ DrawConnectionHeader()

◆ IsConnected()

◆ Connect()

◆ ConnectToPath()

◆ Disconnect()

◆ RefreshSocketList()

◆ DrawVariableTable()

◆ DrawGroupHeader()

◆ DrawVariableRow()

◆ DrawCrystalBitfield()

◆ DrawGameStateDropdown()

◆ RefreshValues()

◆ LoadVariablesFromManifest()

◆ PokeValue()

Member Data Documentation

◆ client_

◆ project_

◆ variables_

◆ variables_loaded_

◆ current_values_

◆ previous_values_

◆ change_timestamps_

◆ auto_refresh_

◆ refresh_interval_

◆ time_since_refresh_

◆ connection_error_

◆ socket_paths_

◆ selected_socket_index_

◆ socket_path_buffer_

◆ status_message_

◆ filter_text_

◆ editing_active_

◆ editing_address_

◆ editing_value_

◆ story_expanded_

◆ dungeon_expanded_

◆ items_expanded_