step.debug_break
================

.. py:module:: step.debug_break


Classes
-------

.. autoapisummary::

   step.debug_break.DebugBreakStep


Functions
---------

.. autoapisummary::

   step.debug_break.debug_break


Module Contents
---------------

.. py:class:: DebugBreakStep(label: str | None = None)

   Bases: :py:obj:`raccoon.ui.UIStep`


   Step-level debug-break marker.

   Behaviour depends on the global ``--debug`` flag
   (``LIBSTP_DEBUG=1``, set by ``raccoon run --debug``):

   * **Debug mode on** — pauses the mission and waits for a hardware
     button press before continuing, like an interactive breakpoint.
   * **Debug mode off** — emits a single log line and returns
     immediately, so the step is effectively a no-op in normal runs.


.. py:function:: debug_break(label: str | None = None) -> DebugBreakStep

   Create a debug-break marker step.

   In debug mode (``raccoon run --debug``) the step pauses the mission
   and waits for a hardware button press. Without ``--debug`` it logs a
   line and returns immediately.

   :param label: Optional label included in the debug-break log message and
                 the on-screen prompt.