SkinLayerStudio API (Beta) / API Reference / Skin

push()

Download Markdown

Writes the skin on screen to the connected DCC node.

If no DCC is connected, result.ok is False. It does not crash with an exception. result.reason holds a short code such as no_dcc.

manual=True is the default. That is the same as a person pressing the save button.

Signature

skin.push(manual=True) -> result
Field Meaning
ok Whether it was written to the DCC.
applied_count How many vertices were applied.
reason Failure code. An empty string on success.
error Failure description.

Example

result = api.skin().push()
print(result.ok, result.applied_count, result.reason)
💬

Need help with the API?

Open a support ticket or join the community discussion.

Contact Support