In threaded mode, this is an async call!
This API will invoke the cooking thread if threading is enabled. This means it will return immediately. Use the status and cooking count APIs under DIAGNOSTICS to get a sense of the progress. All other API calls will block until the cook operation has finished.
Also note that the cook result won’t be of type hapi.statusType.CallResult like all calls (including this one). Whenever the threading cook is done it will fill the cook result which is queried using hapi.statusType.CookResult.
Usage ¶
cookNode(session
: hapi.Session, node_id
: int
, cook_options
: hapi.CookOptions) → bool
Initiate a cook on this node. Note that this may trigger cooks on other nodes if they are connected.
session
The session of Houdini you are interacting with. See hapi.Session for more on sessions. Pass None to just use the default in-process session.
node_id
The node id.
cook_options
The cook options. Pass in None to use the global cook options that you specified when calling hapi.initialize.