step.timing.wait_for_checkpoint_dsl
===================================

.. py:module:: step.timing.wait_for_checkpoint_dsl

.. autoapi-nested-parse::

   Auto-generated step builders and DSL functions — DO NOT EDIT.

   Source: wait_for_checkpoint.py



Classes
-------

.. autoapisummary::

   step.timing.wait_for_checkpoint_dsl.WaitForCheckpointBuilder


Functions
---------

.. autoapisummary::

   step.timing.wait_for_checkpoint_dsl.wait_for_checkpoint


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

.. py:class:: WaitForCheckpointBuilder

   Bases: :py:obj:`raccoon.step.step_builder.StepBuilder`


   Builder for WaitForCheckpoint. Auto-generated — do not edit.


   .. py:method:: checkpoint_seconds(value: Union[float, int])


.. py:function:: wait_for_checkpoint(checkpoint_seconds: Union[float, int] = _UNSET)

   Wait until a mission-relative time checkpoint is reached.

   Pauses execution until the robot's global synchronizer clock reaches
   the specified number of seconds since mission start. While waiting,
   a full-screen countdown UI shows the remaining time. If the
   checkpoint time has already passed, the step returns immediately
   without showing any UI. This is useful for synchronizing actions to
   absolute times within a timed Botball run (e.g. "at T=20s, start
   collecting").

   Prerequisites:
       The robot must have a ``synchronizer`` configured. The synchronizer
       clock starts when the mission begins.

   :param checkpoint_seconds: The mission-relative time (in seconds) to wait for. Must be non-negative.

   :returns: A WaitForCheckpointBuilder (chainable via ``.checkpoint_seconds()``, ``.on_anomaly()``, ``.skip_timing()``).

   Example::

       from raccoon.step.timing import wait_for_checkpoint

       seq([
           drive_forward(50),
           # Ensure we don't start the next action before T=10s
           wait_for_checkpoint(10.0),
           pick_up_tribble(),
           # Gate the final action to T=25s
           wait_for_checkpoint(25.0),
           drive_to_bin(),
       ])