wolfhece.plugins.state
======================

.. py:module:: wolfhece.plugins.state

.. autoapi-nested-parse::

   State helpers for companion plugins.





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

.. py:class:: CompanionState

   Minimal resettable key/value store for companion state.

   Subclass this to get typed attributes::

       class _MyState(CompanionState):
           start_xy: tuple | None = None
           end_xy:   tuple | None = None


   .. py:attribute:: step
      :type:  int


   .. py:method:: reset() -> None

      Reset ``step`` and public mutable attributes to class defaults.



   .. py:method:: advance() -> int

      Increment *step* and return the new value.