wolfhece._builtin_plugins._template.companion

Template companion plugin.

Replace every occurrence of MyPlugin / my_plugin with your own name, then implement the methods below.

Rename this directory to match the name field in plugin.toml (removing the leading _ so it is auto-discovered).

Module Contents

wolfhece._builtin_plugins._template.companion._WXK_ESCAPE = 27

class wolfhece._builtin_plugins._template.companion.MyPluginCompanion(viewer: wolfhece.PyDraw.WolfMapViewer, dialogs: wolfhece.dialog_provider.DialogProvider | None = None, namespace: str | None = None)

Bases: wolfhece._menu_companion_abc.AbstractCompanion

Minimal template — replace with your implementation.

menu_build() → None

Add a top-level menu entry. Remove if no menu is needed.

start() → None

Called when the companion is activated programmatically.

_on_run(event) → None

_rdown(viewer, ctx: wolfhece._viewer_plugin_handlers.MouseContext) → None

_key(viewer, kb: wolfhece._viewer_plugin_handlers.KeyboardSnapshot) → bool

_paint(viewer) → None