Visual dashboard of Oracle game state from SRAM data. More...

#include <progression_dashboard_panel.h>

Inheritance diagram for yaze::editor::ProgressionDashboardPanel:

[legend]

Collaboration diagram for yaze::editor::ProgressionDashboardPanel:

[legend]

Public Member Functions
	~ProgressionDashboardPanel () override

std::string	GetId () const override
	Unique identifier for this panel.

std::string	GetDisplayName () const override
	Human-readable name shown in menus and title bars.

std::string	GetIcon () const override
	Material Design icon for this panel.

std::string	GetEditorCategory () const override
	Editor category this panel belongs to.

std::string	GetWorkflowGroup () const override
	Optional workflow group for hack-centric actions.

std::string	GetWorkflowDescription () const override
	Optional workflow description for menus/command palette.

bool	IsEnabled () const override
	Check if this panel is currently enabled.

std::string	GetDisabledTooltip () const override
	Get tooltip text when panel is disabled.

WindowLifecycle	GetWindowLifecycle () const override
	Get the lifecycle category for this window.

float	GetPreferredWidth () const override
	Get preferred width for this panel (optional)

void	Draw (bool *p_open) override
	Draw the panel content.

	~ProgressionDashboardPanel () override

std::string	GetId () const override
	Unique identifier for this panel.

std::string	GetDisplayName () const override
	Human-readable name shown in menus and title bars.

std::string	GetIcon () const override
	Material Design icon for this panel.

std::string	GetEditorCategory () const override
	Editor category this panel belongs to.

std::string	GetWorkflowGroup () const override
	Optional workflow group for hack-centric actions.

std::string	GetWorkflowDescription () const override
	Optional workflow description for menus/command palette.

bool	IsEnabled () const override
	Check if this panel is currently enabled.

std::string	GetDisabledTooltip () const override
	Get tooltip text when panel is disabled.

WindowLifecycle	GetWindowLifecycle () const override
	Get the lifecycle category for this window.

float	GetPreferredWidth () const override
	Get preferred width for this panel (optional)

void	Draw (bool *p_open) override
	Draw the panel content.

Public Member Functions inherited from yaze::editor::WindowContent
virtual	~WindowContent ()=default

virtual void	OnFirstDraw ()
	Called once before the first Draw() in a session.

virtual bool	RequiresLazyInit () const
	Whether this panel uses lazy initialization.

void	InvalidateLazyInit ()
	Reset lazy init state so OnFirstDraw() runs again.

virtual void	OnOpen ()
	Called when panel becomes visible.

virtual void	OnClose ()
	Called when panel is hidden.

virtual void	OnFocus ()
	Called when panel receives focus.

virtual WindowContextScope	GetContextScope () const
	Optional context binding for this window (room/selection/etc)

virtual WindowScope	GetScope () const
	Get the registration scope for this window.

virtual std::string	GetShortcutHint () const
	Get keyboard shortcut hint for display.

virtual int	GetPriority () const
	Get display priority for menu ordering.

virtual std::string	GetWorkflowLabel () const
	Optional workflow label for menus/command palette.

virtual int	GetWorkflowPriority () const
	Optional workflow ordering priority (lower sorts first).

virtual float	GetPreferredHeight () const
	Get preferred height for this panel (optional)

virtual bool	PreferAutoHideTabBar () const
	Whether the dock node hosting this panel should auto-hide its tab bar.

virtual bool	IsVisibleByDefault () const
	Whether this panel should be visible by default.

virtual std::string	GetParentPanelId () const
	Get parent panel ID for cascade behavior.

virtual bool	CascadeCloseChildren () const
	Whether closing this panel should close child panels.

void	DrawWithLazyInit (bool *p_open)
	Execute lazy initialization if needed, then call Draw()

Private Member Functions
void	DrawSrmImportControls ()

void	DrawLiveSyncControls ()

void	PushStateToManifestIfNeeded ()

void	DrawCrystalTracker ()

void	DrawGameState ()

void	DrawDungeonGrid ()

void	DrawStoryFlags ()

void	DrawManualControls ()

void	RefreshLiveClientBinding ()

void	EnsureLiveSubscription ()

void	ProcessPendingLiveRefresh ()

bool	RefreshStateFromLiveSram ()

void	DetachLiveListener ()

workflow::HackWorkflowBackend *	GetWorkflowBackend () const

workflow::ProgressionCapability *	GetProgressionBackend () const

void	DrawSrmImportControls ()

void	DrawLiveSyncControls ()

void	PushStateToManifestIfNeeded ()

void	DrawCrystalTracker ()

void	DrawGameState ()

void	DrawDungeonGrid ()

void	DrawStoryFlags ()

void	DrawManualControls ()

void	RefreshLiveClientBinding ()

void	EnsureLiveSubscription ()

void	ProcessPendingLiveRefresh ()

bool	RefreshStateFromLiveSram ()

void	DetachLiveListener ()

workflow::HackWorkflowBackend *	GetWorkflowBackend () const

workflow::ProgressionCapability *	GetProgressionBackend () const

Static Private Member Functions
static bool	StatesEqual (const core::OracleProgressionState &a, const core::OracleProgressionState &b)

static void	DrawBitGrid (const char id_prefix, uint8_t value, const char const *labels)

static bool	StatesEqual (const core::OracleProgressionState &a, const core::OracleProgressionState &b)

static void	DrawBitGrid (const char id_prefix, uint8_t value, const char const *labels)

Private Attributes
core::OracleProgressionState	state_

int	game_state_slider_ = 0

core::HackManifest *	manifest_ = nullptr

std::string	loaded_srm_path_

std::string	last_srm_error_

std::shared_ptr< emu::mesen::MesenSocketClient >	live_client_

emu::mesen::EventListenerId	live_listener_id_ = 0

bool	live_sync_enabled_ = true

bool	live_subscription_active_ = false

std::atomic< bool >	live_refresh_pending_ {false}

float	live_refresh_interval_seconds_ = 0.10f

double	last_live_refresh_time_ = 0.0

double	last_subscribe_attempt_time_ = 0.0

std::string	live_sync_error_

Static Private Attributes
static constexpr const char *	oosprog_labels_ [8]

static constexpr const char *	oosprog2_labels_ [8]

Additional Inherited Members
Protected Member Functions inherited from yaze::editor::WindowContent
void	InvalidateCache ()
	Invalidate all cached computations.

template<typename T >
T &	GetCached (const std::string &key, std::function< T()> compute)
	Get or compute a cached value.

bool	IsCacheValid () const
	Check if cache has been invalidated.

void	ClearCache ()
	Clear all cached values (more aggressive than InvalidateCache)

Detailed Description

Visual dashboard of Oracle game state from SRAM data.

Shows crystal tracker, game state phase, story flags, and dungeon completion grid. Supports .srm file import and manual bit toggles for testing.

Definition at line 35 of file progression_dashboard_panel.h.

Constructor & Destructor Documentation

◆ ~ProgressionDashboardPanel() [1/2]

yaze::editor::ProgressionDashboardPanel::~ProgressionDashboardPanel ( )

inlineoverride

Definition at line 37 of file progression_dashboard_panel.h.

References DetachLiveListener().

Here is the call graph for this function:

◆ ~ProgressionDashboardPanel() [2/2]

yaze::editor::ProgressionDashboardPanel::~ProgressionDashboardPanel ( )

inlineoverride

Definition at line 37 of file progression_dashboard_panel.h.

References DetachLiveListener().

Here is the call graph for this function:

Member Function Documentation

◆ GetId() [1/2]

std::string yaze::editor::ProgressionDashboardPanel::GetId ( ) const

inlineoverridevirtual

Unique identifier for this panel.

Returns: Panel ID in format "{category}.{name}" (e.g., "dungeon.room_selector")

IDs should be:

Lowercase with underscores
Prefixed with editor category
Unique across all panels

Implements yaze::editor::WindowContent.

Definition at line 39 of file progression_dashboard_panel.h.

◆ GetDisplayName() [1/2]

std::string yaze::editor::ProgressionDashboardPanel::GetDisplayName ( ) const

inlineoverridevirtual

Human-readable name shown in menus and title bars.

Returns: Display name (e.g., "Room Selector")

Implements yaze::editor::WindowContent.

Definition at line 40 of file progression_dashboard_panel.h.

◆ GetIcon() [1/2]

std::string yaze::editor::ProgressionDashboardPanel::GetIcon ( ) const

inlineoverridevirtual

Material Design icon for this panel.

Returns: Icon constant (e.g., ICON_MD_LIST)

Implements yaze::editor::WindowContent.

Definition at line 41 of file progression_dashboard_panel.h.

References ICON_MD_DASHBOARD.

◆ GetEditorCategory() [1/2]

std::string yaze::editor::ProgressionDashboardPanel::GetEditorCategory ( ) const

inlineoverridevirtual

Editor category this panel belongs to.

Returns: Category name matching EditorType (e.g., "Dungeon", "Overworld")

Implements yaze::editor::WindowContent.

Definition at line 42 of file progression_dashboard_panel.h.

◆ GetWorkflowGroup() [1/2]

std::string yaze::editor::ProgressionDashboardPanel::GetWorkflowGroup ( ) const

inlineoverridevirtual

Optional workflow group for hack-centric actions.

Returns: Non-empty group name to surface this panel in hack workflows.

Reimplemented from yaze::editor::WindowContent.

Definition at line 43 of file progression_dashboard_panel.h.

◆ GetWorkflowDescription() [1/2]

std::string yaze::editor::ProgressionDashboardPanel::GetWorkflowDescription ( ) const

inlineoverridevirtual

Optional workflow description for menus/command palette.

Reimplemented from yaze::editor::WindowContent.

Definition at line 44 of file progression_dashboard_panel.h.

◆ IsEnabled() [1/2]

bool yaze::editor::ProgressionDashboardPanel::IsEnabled ( ) const

inlineoverridevirtual

Check if this panel is currently enabled.

Returns: true if panel can be shown, false if disabled

Disabled panels appear grayed out in menus. Override to implement conditional availability (e.g., requires ROM loaded).

Reimplemented from yaze::editor::WindowContent.

Definition at line 47 of file progression_dashboard_panel.h.

References yaze::editor::ContentRegistry::Context::current_project(), and GetProgressionBackend().

Referenced by Draw().

Here is the call graph for this function:

◆ GetDisabledTooltip() [1/2]

std::string yaze::editor::ProgressionDashboardPanel::GetDisabledTooltip ( ) const

inlineoverridevirtual

Get tooltip text when panel is disabled.

Returns: Explanation of why panel is disabled (e.g., "Requires ROM to be loaded")

Reimplemented from yaze::editor::WindowContent.

Definition at line 53 of file progression_dashboard_panel.h.

Referenced by Draw().

◆ GetWindowLifecycle() [1/2]

WindowLifecycle yaze::editor::ProgressionDashboardPanel::GetWindowLifecycle ( ) const

inlineoverridevirtual

Get the lifecycle category for this window.

Returns: WindowLifecycle determining visibility behavior on editor switch

Default is EditorBound (hidden when switching editors).

Reimplemented from yaze::editor::WindowContent.

Definition at line 56 of file progression_dashboard_panel.h.

References yaze::editor::CrossEditor.

◆ GetPreferredWidth() [1/2]

float yaze::editor::ProgressionDashboardPanel::GetPreferredWidth ( ) const

inlineoverridevirtual

Get preferred width for this panel (optional)

Returns: Preferred width in pixels, or 0 to use default (250px)

Override this to specify content-based sizing. For example, a tile selector with 8 tiles at 16px × 2.0 scale would return ~276px.

Reimplemented from yaze::editor::WindowContent.

Definition at line 59 of file progression_dashboard_panel.h.

◆ Draw() [1/2]

void yaze::editor::ProgressionDashboardPanel::Draw ( bool * p_open )

inlineoverridevirtual

Draw the panel content.

Parameters

p_open Pointer to visibility flag (nullptr if not closable)

Called by WorkspaceWindowManager when the panel is visible. Do NOT call ImGui::Begin/End - the PanelWindow wrapper handles that. Just draw your content directly.

Implements yaze::editor::WindowContent.

Definition at line 61 of file progression_dashboard_panel.h.

References yaze::editor::ContentRegistry::Context::current_project(), DrawCrystalTracker(), DrawDungeonGrid(), DrawGameState(), DrawManualControls(), DrawSrmImportControls(), DrawStoryFlags(), EnsureLiveSubscription(), GetDisabledTooltip(), GetWorkflowBackend(), IsEnabled(), manifest_, ProcessPendingLiveRefresh(), PushStateToManifestIfNeeded(), and RefreshLiveClientBinding().

◆ StatesEqual() [1/2]

static bool yaze::editor::ProgressionDashboardPanel::StatesEqual	(	const core::OracleProgressionState &	a,
		const core::OracleProgressionState &	b )

inlinestaticprivate

Definition at line 100 of file progression_dashboard_panel.h.

References yaze::core::OracleProgressionState::crystal_bitfield, yaze::core::OracleProgressionState::game_state, yaze::core::OracleProgressionState::oosprog, yaze::core::OracleProgressionState::oosprog2, yaze::core::OracleProgressionState::pendants, and yaze::core::OracleProgressionState::side_quest.

Referenced by PushStateToManifestIfNeeded().

◆ DrawSrmImportControls() [1/2]

void yaze::editor::ProgressionDashboardPanel::DrawSrmImportControls ( )

inlineprivate

Definition at line 108 of file progression_dashboard_panel.h.

References yaze::core::HackManifest::ClearOracleProgressionState(), DrawLiveSyncControls(), yaze::util::FileDialogOptions::filters, yaze::core::OracleProgressionState::game_state, game_state_slider_, GetProgressionBackend(), last_srm_error_, loaded_srm_path_, yaze::core::LoadOracleProgressionFromSrmFile(), yaze::editor::workflow::ProgressionCapability::LoadProgressionStateFromFile(), manifest_, yaze::util::FileDialogWrapper::ShowOpenFileDialog(), and state_.

Referenced by Draw().

◆ DrawLiveSyncControls() [1/2]

void yaze::editor::ProgressionDashboardPanel::DrawLiveSyncControls ( )

inlineprivate

Definition at line 170 of file progression_dashboard_panel.h.

References live_client_, live_refresh_interval_seconds_, live_refresh_pending_, live_sync_enabled_, live_sync_error_, and RefreshStateFromLiveSram().

Referenced by DrawSrmImportControls().

Here is the call graph for this function:

◆ PushStateToManifestIfNeeded() [1/2]

void yaze::editor::ProgressionDashboardPanel::PushStateToManifestIfNeeded ( )

inlineprivate

Definition at line 205 of file progression_dashboard_panel.h.

References GetProgressionBackend(), yaze::core::HackManifest::loaded(), manifest_, yaze::core::HackManifest::oracle_progression_state(), yaze::core::HackManifest::SetOracleProgressionState(), state_, and StatesEqual().

Referenced by Draw().

◆ DrawCrystalTracker() [1/2]

void yaze::editor::ProgressionDashboardPanel::DrawCrystalTracker ( )

inlineprivate

Definition at line 227 of file progression_dashboard_panel.h.

References yaze::core::OracleProgressionState::crystal_bitfield, yaze::core::OracleProgressionState::GetCrystalCount(), yaze::core::OracleProgressionState::GetCrystalMask(), and state_.

Referenced by Draw().

Here is the call graph for this function:

◆ DrawGameState() [1/2]

void yaze::editor::ProgressionDashboardPanel::DrawGameState ( )

inlineprivate

Definition at line 261 of file progression_dashboard_panel.h.

References yaze::core::OracleProgressionState::game_state, yaze::core::OracleProgressionState::GetGameStateName(), and state_.

Referenced by Draw().

Here is the call graph for this function:

◆ DrawDungeonGrid() [1/2]

void yaze::editor::ProgressionDashboardPanel::DrawDungeonGrid ( )

inlineprivate

Definition at line 295 of file progression_dashboard_panel.h.

References yaze::core::OracleProgressionState::IsDungeonComplete(), and state_.

Referenced by Draw().

Here is the call graph for this function:

◆ DrawStoryFlags() [1/2]

void yaze::editor::ProgressionDashboardPanel::DrawStoryFlags ( )

inlineprivate

Definition at line 332 of file progression_dashboard_panel.h.

References DrawBitGrid(), yaze::core::OracleProgressionState::oosprog, yaze::core::OracleProgressionState::oosprog2, oosprog2_labels_, oosprog_labels_, yaze::core::OracleProgressionState::side_quest, and state_.

Referenced by Draw().

Here is the call graph for this function:

◆ DrawBitGrid() [1/2]

static void yaze::editor::ProgressionDashboardPanel::DrawBitGrid	(	const char *	id_prefix,
		uint8_t	value,
		const char const	labels )

inlinestaticprivate

Definition at line 354 of file progression_dashboard_panel.h.

Referenced by DrawStoryFlags().

◆ DrawManualControls() [1/2]

void yaze::editor::ProgressionDashboardPanel::DrawManualControls ( )

inlineprivate

Definition at line 373 of file progression_dashboard_panel.h.

References yaze::core::OracleProgressionState::crystal_bitfield, yaze::core::OracleProgressionState::game_state, game_state_slider_, and state_.

Referenced by Draw().

◆ RefreshLiveClientBinding() [1/2]

void yaze::editor::ProgressionDashboardPanel::RefreshLiveClientBinding ( )

inlineprivate

Definition at line 401 of file progression_dashboard_panel.h.

References DetachLiveListener(), yaze::emu::mesen::MesenClientRegistry::GetClient(), live_client_, live_refresh_pending_, live_subscription_active_, and live_sync_error_.

Referenced by Draw().

Here is the call graph for this function:

◆ EnsureLiveSubscription() [1/2]

void yaze::editor::ProgressionDashboardPanel::EnsureLiveSubscription ( )

inlineprivate

Definition at line 417 of file progression_dashboard_panel.h.

References last_subscribe_attempt_time_, live_client_, live_listener_id_, live_refresh_pending_, live_subscription_active_, live_sync_enabled_, live_sync_error_, and yaze::emu::mesen::MesenEvent::type.

Referenced by Draw().

◆ ProcessPendingLiveRefresh() [1/2]

void yaze::editor::ProgressionDashboardPanel::ProcessPendingLiveRefresh ( )

inlineprivate

Definition at line 457 of file progression_dashboard_panel.h.

References last_live_refresh_time_, live_refresh_interval_seconds_, live_refresh_pending_, live_sync_enabled_, and RefreshStateFromLiveSram().

Referenced by Draw().

Here is the call graph for this function:

◆ RefreshStateFromLiveSram() [1/2]

bool yaze::editor::ProgressionDashboardPanel::RefreshStateFromLiveSram ( )

inlineprivate

Definition at line 474 of file progression_dashboard_panel.h.

Referenced by DrawLiveSyncControls(), and ProcessPendingLiveRefresh().

Here is the call graph for this function:

◆ DetachLiveListener() [1/2]

void yaze::editor::ProgressionDashboardPanel::DetachLiveListener ( )

inlineprivate

Definition at line 533 of file progression_dashboard_panel.h.

References live_client_, live_listener_id_, and live_subscription_active_.

Referenced by RefreshLiveClientBinding(), and ~ProgressionDashboardPanel().

◆ GetWorkflowBackend() [1/2]

workflow::HackWorkflowBackend * yaze::editor::ProgressionDashboardPanel::GetWorkflowBackend ( ) const

inlineprivate

Definition at line 541 of file progression_dashboard_panel.h.

References yaze::editor::ContentRegistry::Context::hack_workflow_backend().

Referenced by Draw().

Here is the call graph for this function:

◆ GetProgressionBackend() [1/2]

workflow::ProgressionCapability * yaze::editor::ProgressionDashboardPanel::GetProgressionBackend ( ) const

inlineprivate

Definition at line 545 of file progression_dashboard_panel.h.

References yaze::editor::ContentRegistry::Context::hack_progression_backend().

Referenced by DrawSrmImportControls(), IsEnabled(), PushStateToManifestIfNeeded(), and RefreshStateFromLiveSram().

Here is the call graph for this function:

◆ GetId() [2/2]

std::string yaze::editor::ProgressionDashboardPanel::GetId ( ) const

inlineoverridevirtual

Unique identifier for this panel.

Returns: Panel ID in format "{category}.{name}" (e.g., "dungeon.room_selector")

IDs should be:

Lowercase with underscores
Prefixed with editor category
Unique across all panels

Implements yaze::editor::WindowContent.

Definition at line 39 of file progression_dashboard_panel.h.

◆ GetDisplayName() [2/2]

std::string yaze::editor::ProgressionDashboardPanel::GetDisplayName ( ) const

inlineoverridevirtual

Human-readable name shown in menus and title bars.

Returns: Display name (e.g., "Room Selector")

Implements yaze::editor::WindowContent.

Definition at line 40 of file progression_dashboard_panel.h.

◆ GetIcon() [2/2]

std::string yaze::editor::ProgressionDashboardPanel::GetIcon ( ) const

inlineoverridevirtual

Material Design icon for this panel.

Returns: Icon constant (e.g., ICON_MD_LIST)

Implements yaze::editor::WindowContent.

Definition at line 41 of file progression_dashboard_panel.h.

References ICON_MD_DASHBOARD.

◆ GetEditorCategory() [2/2]

std::string yaze::editor::ProgressionDashboardPanel::GetEditorCategory ( ) const

inlineoverridevirtual

Editor category this panel belongs to.

Returns: Category name matching EditorType (e.g., "Dungeon", "Overworld")

Implements yaze::editor::WindowContent.

Definition at line 42 of file progression_dashboard_panel.h.

◆ GetWorkflowGroup() [2/2]

std::string yaze::editor::ProgressionDashboardPanel::GetWorkflowGroup ( ) const

inlineoverridevirtual

Optional workflow group for hack-centric actions.

Returns: Non-empty group name to surface this panel in hack workflows.

Reimplemented from yaze::editor::WindowContent.

Definition at line 43 of file progression_dashboard_panel.h.

◆ GetWorkflowDescription() [2/2]

std::string yaze::editor::ProgressionDashboardPanel::GetWorkflowDescription ( ) const

inlineoverridevirtual

Optional workflow description for menus/command palette.

Reimplemented from yaze::editor::WindowContent.

Definition at line 44 of file progression_dashboard_panel.h.

◆ IsEnabled() [2/2]

bool yaze::editor::ProgressionDashboardPanel::IsEnabled ( ) const

inlineoverridevirtual

Check if this panel is currently enabled.

Returns: true if panel can be shown, false if disabled

Disabled panels appear grayed out in menus. Override to implement conditional availability (e.g., requires ROM loaded).

Reimplemented from yaze::editor::WindowContent.

Definition at line 47 of file progression_dashboard_panel.h.

References yaze::editor::ContentRegistry::Context::current_project(), and GetProgressionBackend().

Here is the call graph for this function:

◆ GetDisabledTooltip() [2/2]

std::string yaze::editor::ProgressionDashboardPanel::GetDisabledTooltip ( ) const

inlineoverridevirtual

Get tooltip text when panel is disabled.

Returns: Explanation of why panel is disabled (e.g., "Requires ROM to be loaded")

Reimplemented from yaze::editor::WindowContent.

Definition at line 53 of file progression_dashboard_panel.h.

◆ GetWindowLifecycle() [2/2]

WindowLifecycle yaze::editor::ProgressionDashboardPanel::GetWindowLifecycle ( ) const

inlineoverridevirtual

Get the lifecycle category for this window.

Returns: WindowLifecycle determining visibility behavior on editor switch

Default is EditorBound (hidden when switching editors).

Reimplemented from yaze::editor::WindowContent.

Definition at line 56 of file progression_dashboard_panel.h.

References yaze::editor::CrossEditor.

◆ GetPreferredWidth() [2/2]

float yaze::editor::ProgressionDashboardPanel::GetPreferredWidth ( ) const

inlineoverridevirtual

Get preferred width for this panel (optional)

Returns: Preferred width in pixels, or 0 to use default (250px)

Override this to specify content-based sizing. For example, a tile selector with 8 tiles at 16px × 2.0 scale would return ~276px.

Reimplemented from yaze::editor::WindowContent.

Definition at line 59 of file progression_dashboard_panel.h.

◆ Draw() [2/2]

void yaze::editor::ProgressionDashboardPanel::Draw ( bool * p_open )

inlineoverridevirtual

Draw the panel content.

Parameters

p_open Pointer to visibility flag (nullptr if not closable)

Called by WorkspaceWindowManager when the panel is visible. Do NOT call ImGui::Begin/End - the PanelWindow wrapper handles that. Just draw your content directly.

Implements yaze::editor::WindowContent.

Definition at line 61 of file progression_dashboard_panel.h.

References yaze::editor::ContentRegistry::Context::current_project(), DrawCrystalTracker(), DrawDungeonGrid(), DrawGameState(), DrawManualControls(), DrawSrmImportControls(), DrawStoryFlags(), EnsureLiveSubscription(), GetDisabledTooltip(), GetWorkflowBackend(), IsEnabled(), manifest_, ProcessPendingLiveRefresh(), PushStateToManifestIfNeeded(), and RefreshLiveClientBinding().

◆ StatesEqual() [2/2]

static bool yaze::editor::ProgressionDashboardPanel::StatesEqual	(	const core::OracleProgressionState &	a,
		const core::OracleProgressionState &	b )

inlinestaticprivate

Definition at line 100 of file progression_dashboard_panel.h.

References yaze::core::OracleProgressionState::crystal_bitfield, yaze::core::OracleProgressionState::game_state, yaze::core::OracleProgressionState::oosprog, yaze::core::OracleProgressionState::oosprog2, yaze::core::OracleProgressionState::pendants, and yaze::core::OracleProgressionState::side_quest.

◆ DrawSrmImportControls() [2/2]

void yaze::editor::ProgressionDashboardPanel::DrawSrmImportControls ( )

inlineprivate

Definition at line 108 of file progression_dashboard_panel.h.

References yaze::core::HackManifest::ClearOracleProgressionState(), DrawLiveSyncControls(), yaze::util::FileDialogOptions::filters, yaze::core::OracleProgressionState::game_state, game_state_slider_, GetProgressionBackend(), last_srm_error_, loaded_srm_path_, yaze::core::LoadOracleProgressionFromSrmFile(), yaze::editor::workflow::ProgressionCapability::LoadProgressionStateFromFile(), manifest_, yaze::util::FileDialogWrapper::ShowOpenFileDialog(), and state_.

◆ DrawLiveSyncControls() [2/2]

void yaze::editor::ProgressionDashboardPanel::DrawLiveSyncControls ( )

inlineprivate

Definition at line 170 of file progression_dashboard_panel.h.

References live_client_, live_refresh_interval_seconds_, live_refresh_pending_, live_sync_enabled_, live_sync_error_, and RefreshStateFromLiveSram().

Here is the call graph for this function:

◆ PushStateToManifestIfNeeded() [2/2]

void yaze::editor::ProgressionDashboardPanel::PushStateToManifestIfNeeded ( )

inlineprivate

Definition at line 205 of file progression_dashboard_panel.h.

References GetProgressionBackend(), yaze::core::HackManifest::loaded(), manifest_, yaze::core::HackManifest::oracle_progression_state(), yaze::core::HackManifest::SetOracleProgressionState(), state_, and StatesEqual().

◆ DrawCrystalTracker() [2/2]

void yaze::editor::ProgressionDashboardPanel::DrawCrystalTracker ( )

inlineprivate

Definition at line 227 of file progression_dashboard_panel.h.

References yaze::core::OracleProgressionState::crystal_bitfield, yaze::core::OracleProgressionState::GetCrystalCount(), yaze::core::OracleProgressionState::GetCrystalMask(), and state_.

Here is the call graph for this function:

◆ DrawGameState() [2/2]

void yaze::editor::ProgressionDashboardPanel::DrawGameState ( )

inlineprivate

Definition at line 261 of file progression_dashboard_panel.h.

References yaze::core::OracleProgressionState::game_state, yaze::core::OracleProgressionState::GetGameStateName(), and state_.

Here is the call graph for this function:

◆ DrawDungeonGrid() [2/2]

void yaze::editor::ProgressionDashboardPanel::DrawDungeonGrid ( )

inlineprivate

Definition at line 295 of file progression_dashboard_panel.h.

References yaze::core::OracleProgressionState::IsDungeonComplete(), and state_.

Here is the call graph for this function:

◆ DrawStoryFlags() [2/2]

void yaze::editor::ProgressionDashboardPanel::DrawStoryFlags ( )

inlineprivate

Definition at line 332 of file progression_dashboard_panel.h.

References DrawBitGrid(), yaze::core::OracleProgressionState::oosprog, yaze::core::OracleProgressionState::oosprog2, oosprog2_labels_, oosprog_labels_, yaze::core::OracleProgressionState::side_quest, and state_.

Here is the call graph for this function:

◆ DrawBitGrid() [2/2]

static void yaze::editor::ProgressionDashboardPanel::DrawBitGrid	(	const char *	id_prefix,
		uint8_t	value,
		const char const	labels )

inlinestaticprivate

Definition at line 354 of file progression_dashboard_panel.h.

◆ DrawManualControls() [2/2]

void yaze::editor::ProgressionDashboardPanel::DrawManualControls ( )

inlineprivate

Definition at line 373 of file progression_dashboard_panel.h.

References yaze::core::OracleProgressionState::crystal_bitfield, yaze::core::OracleProgressionState::game_state, game_state_slider_, and state_.

◆ RefreshLiveClientBinding() [2/2]

void yaze::editor::ProgressionDashboardPanel::RefreshLiveClientBinding ( )

inlineprivate

Definition at line 401 of file progression_dashboard_panel.h.

References DetachLiveListener(), yaze::emu::mesen::MesenClientRegistry::GetClient(), live_client_, live_refresh_pending_, live_subscription_active_, and live_sync_error_.

Here is the call graph for this function:

◆ EnsureLiveSubscription() [2/2]

void yaze::editor::ProgressionDashboardPanel::EnsureLiveSubscription ( )

inlineprivate

Definition at line 417 of file progression_dashboard_panel.h.

References last_subscribe_attempt_time_, live_client_, live_listener_id_, live_refresh_pending_, live_subscription_active_, live_sync_enabled_, live_sync_error_, and yaze::emu::mesen::MesenEvent::type.

◆ ProcessPendingLiveRefresh() [2/2]

void yaze::editor::ProgressionDashboardPanel::ProcessPendingLiveRefresh ( )

inlineprivate

Definition at line 457 of file progression_dashboard_panel.h.

References last_live_refresh_time_, live_refresh_interval_seconds_, live_refresh_pending_, live_sync_enabled_, and RefreshStateFromLiveSram().

Here is the call graph for this function:

◆ RefreshStateFromLiveSram() [2/2]

bool yaze::editor::ProgressionDashboardPanel::RefreshStateFromLiveSram ( )

inlineprivate

Definition at line 474 of file progression_dashboard_panel.h.

Here is the call graph for this function:

◆ DetachLiveListener() [2/2]

void yaze::editor::ProgressionDashboardPanel::DetachLiveListener ( )

inlineprivate

Definition at line 533 of file progression_dashboard_panel.h.

References live_client_, live_listener_id_, and live_subscription_active_.

◆ GetWorkflowBackend() [2/2]

workflow::HackWorkflowBackend * yaze::editor::ProgressionDashboardPanel::GetWorkflowBackend ( ) const

inlineprivate

Definition at line 541 of file progression_dashboard_panel.h.

References yaze::editor::ContentRegistry::Context::hack_workflow_backend().

Here is the call graph for this function:

◆ GetProgressionBackend() [2/2]

workflow::ProgressionCapability * yaze::editor::ProgressionDashboardPanel::GetProgressionBackend ( ) const

inlineprivate

Definition at line 545 of file progression_dashboard_panel.h.

References yaze::editor::ContentRegistry::Context::hack_progression_backend().

Here is the call graph for this function:

Member Data Documentation

◆ state_

core::OracleProgressionState yaze::editor::ProgressionDashboardPanel::state_

private

Definition at line 549 of file progression_dashboard_panel.h.

Referenced by DrawCrystalTracker(), DrawDungeonGrid(), DrawGameState(), DrawManualControls(), DrawSrmImportControls(), DrawStoryFlags(), PushStateToManifestIfNeeded(), and RefreshStateFromLiveSram().

◆ game_state_slider_

int yaze::editor::ProgressionDashboardPanel::game_state_slider_ = 0

private

Definition at line 550 of file progression_dashboard_panel.h.

Referenced by DrawManualControls(), DrawSrmImportControls(), and RefreshStateFromLiveSram().

◆ manifest_

core::HackManifest * yaze::editor::ProgressionDashboardPanel::manifest_ = nullptr

private

Definition at line 552 of file progression_dashboard_panel.h.

Referenced by Draw(), DrawSrmImportControls(), and PushStateToManifestIfNeeded().

◆ loaded_srm_path_

std::string yaze::editor::ProgressionDashboardPanel::loaded_srm_path_

private

Definition at line 553 of file progression_dashboard_panel.h.

Referenced by DrawSrmImportControls(), and RefreshStateFromLiveSram().

◆ last_srm_error_

std::string yaze::editor::ProgressionDashboardPanel::last_srm_error_

private

Definition at line 554 of file progression_dashboard_panel.h.

Referenced by DrawSrmImportControls(), and RefreshStateFromLiveSram().

◆ live_client_

std::shared_ptr< emu::mesen::MesenSocketClient > yaze::editor::ProgressionDashboardPanel::live_client_

private

Definition at line 556 of file progression_dashboard_panel.h.

Referenced by DetachLiveListener(), DrawLiveSyncControls(), EnsureLiveSubscription(), RefreshLiveClientBinding(), and RefreshStateFromLiveSram().

◆ live_listener_id_

emu::mesen::EventListenerId yaze::editor::ProgressionDashboardPanel::live_listener_id_ = 0

private

Definition at line 557 of file progression_dashboard_panel.h.

Referenced by DetachLiveListener(), and EnsureLiveSubscription().

◆ live_sync_enabled_

bool yaze::editor::ProgressionDashboardPanel::live_sync_enabled_ = true

private

Definition at line 558 of file progression_dashboard_panel.h.

Referenced by DrawLiveSyncControls(), EnsureLiveSubscription(), and ProcessPendingLiveRefresh().

◆ live_subscription_active_

bool yaze::editor::ProgressionDashboardPanel::live_subscription_active_ = false

private

Definition at line 559 of file progression_dashboard_panel.h.

Referenced by DetachLiveListener(), EnsureLiveSubscription(), and RefreshLiveClientBinding().

◆ live_refresh_pending_

std::atomic< bool > yaze::editor::ProgressionDashboardPanel::live_refresh_pending_ {false}

private

Definition at line 560 of file progression_dashboard_panel.h.

Referenced by DrawLiveSyncControls(), EnsureLiveSubscription(), ProcessPendingLiveRefresh(), and RefreshLiveClientBinding().

◆ live_refresh_interval_seconds_

float yaze::editor::ProgressionDashboardPanel::live_refresh_interval_seconds_ = 0.10f

private

Definition at line 561 of file progression_dashboard_panel.h.

Referenced by DrawLiveSyncControls(), and ProcessPendingLiveRefresh().

◆ last_live_refresh_time_

double yaze::editor::ProgressionDashboardPanel::last_live_refresh_time_ = 0.0

private

Definition at line 562 of file progression_dashboard_panel.h.

Referenced by ProcessPendingLiveRefresh().

◆ last_subscribe_attempt_time_

double yaze::editor::ProgressionDashboardPanel::last_subscribe_attempt_time_ = 0.0

private

Definition at line 563 of file progression_dashboard_panel.h.

Referenced by EnsureLiveSubscription().

◆ live_sync_error_

std::string yaze::editor::ProgressionDashboardPanel::live_sync_error_

private

Definition at line 564 of file progression_dashboard_panel.h.

Referenced by DrawLiveSyncControls(), EnsureLiveSubscription(), RefreshLiveClientBinding(), and RefreshStateFromLiveSram().

◆ oosprog_labels_

static constexpr const char * yaze::editor::ProgressionDashboardPanel::oosprog_labels_

staticconstexprprivate

Initial value:

= {
      "Bit0",     "HallOfSecrets", "PendantQuest", "Bit3",
      "ElderMet", "Bit5",          "Bit6",         "FortressComplete",
  }

Definition at line 567 of file progression_dashboard_panel.h.

Referenced by DrawStoryFlags().

◆ oosprog2_labels_

static constexpr const char * yaze::editor::ProgressionDashboardPanel::oosprog2_labels_

staticconstexprprivate

Initial value:

= {
      "Bit0", "Bit1",          "KydrogEncounter",
      "Bit3", "DekuSoulFreed", "BookOfSecrets",
      "Bit6", "Bit7",
  }

Definition at line 572 of file progression_dashboard_panel.h.

Referenced by DrawStoryFlags().

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

src/app/editor/hack/oracle/ui/progression_dashboard_panel.h
src/app/editor/oracle/panels/progression_dashboard_panel.h

	yaze 0.3.2 Link to the Past ROM Editor

Public Member Functions

Private Member Functions

Static Private Member Functions

Private Attributes

Static Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ~ProgressionDashboardPanel() [1/2]

◆ ~ProgressionDashboardPanel() [2/2]

Member Function Documentation

◆ GetId() [1/2]

◆ GetDisplayName() [1/2]

◆ GetIcon() [1/2]

◆ GetEditorCategory() [1/2]

◆ GetWorkflowGroup() [1/2]

◆ GetWorkflowDescription() [1/2]

◆ IsEnabled() [1/2]

◆ GetDisabledTooltip() [1/2]

◆ GetWindowLifecycle() [1/2]

◆ GetPreferredWidth() [1/2]

◆ Draw() [1/2]

◆ StatesEqual() [1/2]

◆ DrawSrmImportControls() [1/2]

◆ DrawLiveSyncControls() [1/2]

◆ PushStateToManifestIfNeeded() [1/2]

◆ DrawCrystalTracker() [1/2]

◆ DrawGameState() [1/2]

◆ DrawDungeonGrid() [1/2]

◆ DrawStoryFlags() [1/2]

◆ DrawBitGrid() [1/2]

◆ DrawManualControls() [1/2]

◆ RefreshLiveClientBinding() [1/2]

◆ EnsureLiveSubscription() [1/2]

◆ ProcessPendingLiveRefresh() [1/2]

◆ RefreshStateFromLiveSram() [1/2]

◆ DetachLiveListener() [1/2]

◆ GetWorkflowBackend() [1/2]

◆ GetProgressionBackend() [1/2]

◆ GetId() [2/2]

◆ GetDisplayName() [2/2]

◆ GetIcon() [2/2]

◆ GetEditorCategory() [2/2]

◆ GetWorkflowGroup() [2/2]

◆ GetWorkflowDescription() [2/2]

◆ IsEnabled() [2/2]

◆ GetDisabledTooltip() [2/2]

◆ GetWindowLifecycle() [2/2]

◆ GetPreferredWidth() [2/2]

◆ Draw() [2/2]

◆ StatesEqual() [2/2]

◆ DrawSrmImportControls() [2/2]

◆ DrawLiveSyncControls() [2/2]

◆ PushStateToManifestIfNeeded() [2/2]

◆ DrawCrystalTracker() [2/2]

◆ DrawGameState() [2/2]

◆ DrawDungeonGrid() [2/2]

◆ DrawStoryFlags() [2/2]

◆ DrawBitGrid() [2/2]

◆ DrawManualControls() [2/2]

◆ RefreshLiveClientBinding() [2/2]

◆ EnsureLiveSubscription() [2/2]

◆ ProcessPendingLiveRefresh() [2/2]

◆ RefreshStateFromLiveSram() [2/2]

◆ DetachLiveListener() [2/2]

◆ GetWorkflowBackend() [2/2]

◆ GetProgressionBackend() [2/2]

Member Data Documentation

◆ state_

◆ game_state_slider_

◆ manifest_

◆ loaded_srm_path_

◆ last_srm_error_

◆ live_client_

◆ live_listener_id_

◆ live_sync_enabled_

◆ live_subscription_active_

◆ live_refresh_pending_

◆ live_refresh_interval_seconds_

◆ last_live_refresh_time_