get_parameters
Read many parameter values at once, matched by name or label substring.
Instructions
Read many parameter values at once, matched by name or label substring.
The batch counterpart of set_parameters. Several unrelated groups of settings ("flame", "wind", "buoy") come back in one call instead of one call each, and unlike get_node_card these are the live values on this node rather than the defaults for its type.
Pass inside instead of node_path to read the same patterns across a
whole network in one call: "every file parm of this material library,
unexpanded" comes back as rows of {node, parm, value, raw_value}, up to
2000 rows. raw_value is the unexpanded text ($JOB/...), shown when it
differs from the value, exactly as for a single node.
Args:
node_path: Node to read.
patterns: Substrings matched against parameter name and label. Omit for
everything, up to the cap. Required with inside, unless
non_default_only or value_contains.
include_defaults: Also report whether each value is still the default,
and, where it differs, the default (default, default_expression).
inside: Network to read instead of a single node.
recursive: With inside, include every descendant, not only children.
Nodes inside locked HDAs (a solver's own internals) are skipped
and counted in skipped_inside_locked_assets.
node_type: With inside, only nodes of this type (e.g. "mtlximage").
include_locked_assets: With recursive, read inside locked HDAs too.
value_contains: Only parameters whose raw text or expression holds
this substring (case-insensitive), e.g. inside="/",
recursive=True, value_contains="/obj/X": every parameter that
still names that node by its absolute path, a deleted one
included. A relative "../X" is not "/obj/X": search "X" to catch
those. No patterns needed.
non_default_only: Only parameters changed from their defaults, each
with its default: "what was changed on every node of this network"
in one call (with inside, no patterns needed). A changed ramp is
one entry holding all its keys; its key parms (ramp2pos...) are
listed only when a pattern names them and not the ramp.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| inside | No | ||
| patterns | No | ||
| node_path | No | ||
| node_type | No | ||
| recursive | No | ||
| value_contains | No | ||
| include_defaults | No | ||
| non_default_only | No | ||
| include_locked_assets | No |