batch
Destructive
Run multiple Houdini operations in one call to build node networks, wire nodes, and set parameters in one undo group; validate steps first and roll back on failure.
Instructions
Run several Houdini tools in one call.
Use it to build a network: many nodes, their wires and their parameters go
in one round trip and one undo group, and a person can undo the whole thing
with one keystroke.
Do not use it when a later step needs to read what an earlier step made.
The list runs without you in the middle, so nothing can branch on a result.
A path is the exception: give a step an `id`, and a later step writes
"$<id>" where it needs the path of the node that step made. So a network of
default node names (box1, attribwrangle3) needs no guess of the name.
A failed batch changes nothing. Every step is checked before any step
runs, and a step with a wrong argument stops the batch. A step that fails
as it runs stops the list, and the steps before it are undone. A step whose
item failed is a failed step, and so is a parameter write that did not
apply. The error names the index of the step and its error.
Returns JSON with one result for each operation, in the order of the
operations, and the picture of every capture step.
A batch that works cooks the display node of each SOP network that it
touched: `check` gives its point and primitive counts, and the touched
nodes that have errors. Read it before you build on the result.
A capture step with no `output` writes to a file of its own, so one batch
can hold several captures.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| operations | Yes | The steps, in order. Each is {"tool": "<tool name>", "params": {...}}, with the arguments that the tool takes on its own. Any tool of this server except batch. Add "id": "name" to a step, and a later step can write "$name" (or "$name/child") for the node path that step returned. |