wolfhece.plugins.actions

Interactive action helpers for companion plugins.

Module Contents

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

Wrap a viewer interactive action that spans multiple input steps.

_action_id_raw: str | wolfhece._action_kind.ActionKind[source]

step_hints: list[str][source]

state: wolfhece.plugins.state.CompanionState = None[source]

_runtime: ViewerProxy | None = None[source]

_active: bool = False[source]

_resolve_runtime(runtime: ViewerProxy | None) → wolfhece.plugins.viewer_proxy.ViewerProxy[source]

property action_id: str[source]: Resolved action id (namespaced when runtime is available).

property is_active: bool[source]

property current_step: int[source]

property current_hint: str[source]

property total_steps: int[source]

start(runtime: ViewerProxy | None = None, message: str = '') → None[source]

advance(runtime: ViewerProxy | None = None) → bool[source]

cancel(runtime: ViewerProxy | None = None, message: str = '') → None[source]