debug.py

debug.py – Debug overlay system with draggable panels, Live Inspector, and performance monitoring.

Refactored for 0.2.6:
- Vertical sidebar (tabs on the left) with reduced width (80px).
- Merged Performance and Console into a single "System" tab with two scrolling frames side‑by‑side.
- Console now properly scrolls and doesn't overflow.
- Added "Tasks" tab for background task monitoring.
- Cleaned up duplicated drag logic (now a mixin).
- Improved code organization and readability.
- Removed dependency on Tabination.get_tab_by_name() for compatibility.

class DraggableMixin

Description

Mixin to add drag‑and‑drop behavior to any overlay.

Methods
def _init_drag(self: Any) -> Any
No documentation
def _handle_drag(self: Any, input_state: InputState, header_rect: pygame.Rect, lock_btn_rect: pygame.Rect, close_btn_rect: pygame.Rect) -> Any
Call this in update() to handle dragging.
def toggle_fixed(self: Any) -> Any
No documentation
def close(self: Any) -> Any
No documentation

class DebugOverlay

Description

Base class for a draggable, fixable, closable debug panel.

Methods
def __init__(self: Any, engine: 'LunaEngine', x: int = 10, y: int = 10, width: int = 200, height: int = 100, title: str = '', text_color: Tuple[int, int, int] = (255, 255, 255)) -> None
No documentation
def refresh(self: Any, dt: float) -> None
No documentation
def render_content(self: Any, renderer: OpenGLRenderer) -> None
No documentation
def update(self: Any, dt: float, input_state: InputState) -> None
No documentation
def render(self: Any, renderer: OpenGLRenderer) -> None
No documentation

class FPSOverlay

Description

No documentation

Methods
def __init__(self: Any, engine: 'LunaEngine', x: int = 10, y: int = 10) -> None
No documentation
def refresh(self: Any, dt: float) -> None
No documentation
def render_content(self: Any, renderer: OpenGLRenderer) -> None
No documentation

class SceneStatsOverlay

Description

No documentation

Methods
def __init__(self: Any, engine: 'LunaEngine', x: int = 200, y: int = 10) -> None
No documentation
def refresh(self: Any, dt: float) -> None
No documentation
def render_content(self: Any, renderer: OpenGLRenderer) -> None
No documentation

class SoundOverlay

Description

No documentation

Methods
def __init__(self: Any, engine: 'LunaEngine', x: int = 420, y: int = 10) -> None
No documentation
def refresh(self: Any, dt: float) -> None
No documentation
def render_content(self: Any, renderer: OpenGLRenderer) -> None
No documentation

class ClockOverlay

Description

No documentation

Methods
def __init__(self: Any, engine: 'LunaEngine', x: int = 10, y: int = 110) -> None
No documentation
def refresh(self: Any, dt: float) -> None
No documentation
def render_content(self: Any, renderer: OpenGLRenderer) -> None
No documentation

class VersionOverlay

Description

No documentation

Methods
def __init__(self: Any, engine: 'LunaEngine', x: int = 180, y: int = 110) -> None
No documentation
def refresh(self: Any, dt: float) -> None
No documentation
def render_content(self: Any, renderer: OpenGLRenderer) -> None
No documentation

class LogLevel

Description

No documentation

Attributes
INFO: Any = 0
WARNING: Any = 1
ERROR: Any = 2
DEBUG: Any = 3
Methods

No methods defined.

class LogEntry

Description

No documentation

Attributes
level: LogLevel = None
message: str = None
timestamp: float = field(default_factory=time.time)
Methods

No methods defined.

class ConsoleLogManager

Description

No documentation

Methods
def __init__(self: Any, max_logs: int = 200) -> Any
No documentation
def add_log(self: Any, level: LogLevel, message: str) -> None
No documentation
def clear(self: Any) -> None
No documentation
def get_filtered(self: Any) -> List[LogEntry]
No documentation

class LiveInspector

Description

Main debugging panel. Organised into tabs on the left side:
- Elements: hierarchy + properties
- Custom Function: user‑defined test functions
- System: performance + console (merged)
- Audio: master volume, effects, source list
- Overlays: manage debug overlays
- Settings: theme, dark mode, utilities
- Tasks: background task status

Methods
def __init__(self: Any, engine: 'LunaEngine', x: int = 100, y: int = 100) -> None
No documentation
def _get_tab_frame(self: Any, tab_name: str) -> Optional[UiFrame]
Return the frame (UiFrame) of the tab with the given name, or None.
def _update_scene_registration(self: Any) -> Any
No documentation
def set_visible(self: Any, visible: bool) -> Any
No documentation
def close(self: Any) -> Any
No documentation
def toggle_fixed(self: Any) -> Any
No documentation
def on_scene_changed(self: Any) -> Any
No documentation
def _setup_content(self: Any, engine: 'LunaEngine') -> Any
No documentation
def _setup_elements_tab(self: Any) -> Any
No documentation
def _update_elements_tab(self: Any) -> Any
No documentation
def _setup_custom_tab(self: Any) -> Any
No documentation
def _setup_system_tab(self: Any) -> Any
No documentation
def _update_console_view_system(self: Any) -> Any
Update the console view in the System tab.
def _update_system_tab(self: Any) -> Any
Update performance metrics and console (called every frame).
def _setup_audio_tab(self: Any) -> Any
No documentation
def _update_audio_tab(self: Any) -> Any
Update audio source values without rebuilding the entire list.
def _update_audio_sources(self: Any) -> Any
Rebuild the source list from scratch (called when source count changes).
def _force_refresh_audio_sources(self: Any) -> Any
Force a rebuild (called by Refresh button).
def _on_master_volume_changed(self: Any, value: float) -> Any
No documentation
def _on_source_volume_changed(self: Any, source: Any, value: float) -> Any
No documentation
def _on_source_pan_changed(self: Any, source: Any, value: float) -> Any
No documentation
def _apply_effect(self: Any) -> Any
No documentation
def _setup_overlays_tab(self: Any) -> Any
No documentation
def _setup_settings_tab(self: Any) -> Any
No documentation
def _force_kill(self: Any) -> Any
No documentation
def _reinit_game(self: Any) -> Any
No documentation
def _clear_all_caches(self: Any) -> Any
No documentation
def _setup_tasks_tab(self: Any) -> Any
No documentation
def _update_tasks_tab(self: Any) -> Any
No documentation
def _update_tasks_view(self: Any) -> Any
No documentation
def _add_label(self: Any, text: Any, x: Any, y: Any, tab_frame: Any, font_size: Any = None) -> Any
No documentation
def _add_value_label(self: Any, initial_text: Any, x: Any, y: Any, tab_frame: Any) -> Any
No documentation
def _get_cpu_model(self: Any) -> str
No documentation
def _get_gpu_info(self: Any) -> str
No documentation
def add_custom_function(self: Any, name: str, callable_obj: Callable, parameters: List[Tuple[str, type]], description: str = '') -> Any
No documentation
def _refresh_custom_dropdown(self: Any) -> Any
No documentation
def _on_custom_func_selected(self: Any, index: int, name: str) -> Any
No documentation
def _execute_custom_func(self: Any) -> Any
No documentation
def _build_root_hierarchy(self: Any) -> Any
No documentation
def recharge(self: Any) -> Any
No documentation
def _build_hierarchy_view(self: Any, elements: List[UIElement]) -> Any
No documentation
def _navigate_back(self: Any) -> Any
No documentation
def _on_element_click_with_cooldown(self: Any, element: UIElement) -> Any
No documentation
def _on_element_click(self: Any, element: UIElement) -> Any
No documentation
def _show_element_properties(self: Any, element: UIElement) -> Any
No documentation
def getOverlays(self: Any) -> List[str]
No documentation
def _add_overlay(self: Any) -> Any
No documentation
def update_overlays_scrolling(self: Any) -> Any
No documentation
def set_debug_manager(self: Any, dm: 'DebugManager') -> Any
No documentation
def update(self: Any, dt: float, input_state: InputState) -> Any
No documentation
def _redirect_console_output(self: Any) -> Any
No documentation
def _restore_console(self: Any) -> Any
No documentation

class DebugManager

Description

No documentation

Methods
def __init__(self: Any, engine: 'LunaEngine') -> None
No documentation
def on_scene_changed(self: Any) -> Any
No documentation
def add_overlay(self: Any, overlay: DebugOverlay) -> None
No documentation
def remove_overlay(self: Any, overlay: DebugOverlay, callback: Optional[Callable] = None) -> None
No documentation
def toggle_all(self: Any) -> None
No documentation
def update(self: Any, dt: float, input_state: InputState) -> None
No documentation
def render(self: Any, renderer: OpenGLRenderer) -> None
No documentation
Back to Misc Module