Regardless of the value, when calling this function on a parameter, if that parameter has a callback function attached to it, that callback function will be called. For example, if the parameter is a button the button will be pressed.

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 ¶

setParmStringValue(session: hapi.Session, node_id: int, value: str, parm_id: int, index: int) → bool

Set (push) a string value. We can only set a single value at a time because we want to avoid fixed size string buffers.

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.

value

The string value.

parm_id

Parameter id of the parameter being updated.

index

Index within the parameter’s values tuple.