session
Report, attach to, start, stop, or interrupt Houdini instances, and list installed versions; use it when Houdini is unreachable or you need another target.
Instructions
Report the Houdini sessions, choose one, or start, stop or interrupt one.
Use it first when a tool says that Houdini is not reachable, and use it to
learn the Houdini version before you use an API that changed between
releases.
Several Houdini sessions can listen at the same time: the graphical one that
holds the work of the user, and a headless one for your own tests. Every
tool result names the session that answered, in `_session`. Read that line
when a scene looks empty or wrong: an empty scene is usually the wrong
session, not a lost scene.
Do not use it to read the scene: scene_overview does that.
action:
"status" — the session that the bridge talks to now, the other
sessions, and the port. Starts nothing, and always
answers.
"list" — every Houdini that runs, with its version, its process
id, its .hip file, whether it has a window and whether it
answers; and the Houdini versions installed.
"attach" — send every later command to the Houdini on `port`. Use it
when "list" shows more than one.
"detach" — forget the attached port and let the bridge choose again.
"interrupt" — stop the call that runs now in the attached Houdini, or
in the one on `port`: a script past its budget, a loop
that will not end. Houdini answers again after it.
"start" — start a headless Houdini (hython) and attach to it.
`version` chooses the release, for example "21.0" or
"21.0.829"; without it, the version of the Houdini window
that runs. A Houdini that already runs is not touched, so
this is the safe way to test while a person works.
"start_gui" — start Houdini with its window and wait for the plugin to
answer, up to 4 minutes. It opens the .hip file at `hip`
when you give one, it stays open when the bridge stops,
and the bridge attaches to it. `version` as for "start".
"stop" — stop the headless Houdini that this bridge started. A
Houdini that you started yourself, or with "start_gui", is
not touched.
Returns JSON. The report says what to do next when nothing answers.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| hip | No | start_gui: the .hip file to open. | |
| port | No | attach: the port of the Houdini to talk to, from list. interrupt: the Houdini to interrupt, when not the attached one. | |
| action | No | One of "status", "list", "attach", "detach", "interrupt", "start", "start_gui", "stop". | status |
| version | No | start and start_gui: the Houdini release, for example "21.0" or "21.0.829". |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |