step.debug_break

Classes

DebugBreakStep

Step-level debug-break marker.

Functions

debug_break(→ DebugBreakStep)

Create a debug-break marker step.

Module Contents

class step.debug_break.DebugBreakStep(label: str | None = None)

Bases: 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.

step.debug_break.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.

Parameters:

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