Skip to content

debug_overlay.md

Latest commit

 

History

History
82 lines (66 loc) · 3.34 KB

debug_overlay.md

File metadata and controls

82 lines (66 loc) · 3.34 KB

Debug Overlay (Отладка)

Debug Overlay — встроенная визуализация для разработки: сетка мира, координаты камеры/точки/мыши, HUD и отладочные логи.

Быстрый старт

import spritePro as s

s.enable_debug(True)
s.set_debug_grid(size=100, label_every=1)
s.set_debug_log_anchor("bottom_left")
s.debug_log_info("Debug enabled")

Возможности

  • Сетка мира (можно поверх/под сценой)
  • HUD с координатами камеры и FPS
  • Координаты точки центра и позиции мыши в мире
  • Логи в углу экрана с авто‑исчезновением и записью в файл

API (через spritePro)

Включение/выключение

  • s.enable_debug(True/False)
  • s.disable_debug()
  • s.toggle_debug()

Логи

  • s.debug_log_info(text, ttl=None)
  • s.debug_log_warning(text, ttl=None)
  • s.debug_log_error(text, ttl=None)
  • s.debug_log_custom(prefix, text, color, ttl=None)
  • s.set_debug_logs_enabled(True/False)
  • s.set_debug_log_anchor("top_left" | "top_right" | "bottom_left" | "bottom_right")

Сетка

  • s.set_debug_grid(size=None, color=None, alpha=None, label_every=None, label_color=None, labels_enabled=None, label_limit=None, label_font_size=None, on_top=None)
  • s.set_debug_grid_enabled(True/False)

Стиль и файл логов

  • s.set_debug_log_style(font_size=None, line_height=None, padding=None, max_lines=None, anchor=None)
  • s.set_debug_camera_style(color=None, font_size=None)
  • s.set_debug_log_file(enabled=None, path=None)
  • s.set_debug_log_palette(info=None, warning=None, error=None)
  • s.set_debug_log_prefixes(info=None, warning=None, error=None)
  • s.set_debug_log_stack_enabled(True/False)
  • s.set_console_log_enabled(True/False)
  • s.set_debug_hud_style(font_size=None, color=None, padding=None, anchor=None, on_top=None)
  • s.set_debug_hud_enabled(show_fps=None, show_camera=None)
  • s.set_debug_camera_input(mouse_button)

Параметры сетки

Сетка и подписи координат рисуются общим модулем spritePro.grid_renderer. Плотность подписей зависит от зума: при уменьшении зума (вид издали) подписи автоматически реже (шаги 1, 2, 5, 10, 25, 50 по сетке), чтобы текст не слипался.

s.set_debug_grid(
    size=100,           # шаг сетки
    color=(80, 80, 80), # цвет линий
    alpha=120,          # прозрачность (0..255)
    label_every=1,      # минимальный шаг подписей (фактический шаг увеличивается при малом зуме)
    label_color=(140, 140, 140),
    labels_enabled=True,
    on_top=False,       # рисовать поверх сцены
)

Пример

def update():
    if s.input.was_pressed(pygame.K_1):
        s.debug_log_info("Info log")
    if s.input.was_pressed(pygame.K_2):
        s.debug_log_warning("Warning log")
    if s.input.was_pressed(pygame.K_3):
        s.debug_log_error("Error log")
    if s.input.was_pressed(pygame.K_4):
        s.debug_log_custom("[net]", "Custom log", (120, 220, 160))