wolfhece.plugins.actions
========================

.. py:module:: wolfhece.plugins.actions

.. autoapi-nested-parse::

   Interactive action helpers for companion plugins.





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

.. py:class:: MultiStepAction(action_id: str | wolfhece._action_kind.ActionKind, step_hints: list[str], state: Optional[wolfhece.plugins.state.CompanionState] = None, runtime: ViewerProxy | None = None)

   Wrap a viewer interactive action that spans multiple input steps.


   .. py:attribute:: _action_id_raw
      :type:  str | wolfhece._action_kind.ActionKind


   .. py:attribute:: step_hints
      :type:  list[str]


   .. py:attribute:: state
      :type:  wolfhece.plugins.state.CompanionState
      :value: None



   .. py:attribute:: _runtime
      :type:  ViewerProxy | None
      :value: None



   .. py:attribute:: _active
      :type:  bool
      :value: False



   .. py:method:: _resolve_runtime(runtime: ViewerProxy | None) -> wolfhece.plugins.viewer_proxy.ViewerProxy


   .. py:property:: action_id
      :type: str


      Resolved action id (namespaced when runtime is available).


   .. py:property:: is_active
      :type: bool



   .. py:property:: current_step
      :type: int



   .. py:property:: current_hint
      :type: str



   .. py:property:: total_steps
      :type: int



   .. py:method:: start(runtime: ViewerProxy | None = None, message: str = '') -> None


   .. py:method:: advance(runtime: ViewerProxy | None = None) -> bool


   .. py:method:: cancel(runtime: ViewerProxy | None = None, message: str = '') -> None