SkinLayerStudio API (Beta) / API Reference / Skin

pull()

Download Markdown

Reads this mesh's skin from the connected DCC.

3ds Max, Maya, or Blender must be connected, and this slot must be linked to a node in that scene. With no link you get a failed result, not an exception. result.ok is False and result.error is no_ipc_handle.

This is not the Pick button on the toolbar. Pick reads the skin and then updates the slot and the screen. This call only reads. It does not replace the mesh in the viewport.

Signature

skin.pull() -> result
Field Meaning
ok Whether the read succeeded.
error Why it failed. Empty on success.
node_name Name of the DCC node that was read.

Example

result = api.skin().pull()
if not result.ok:
    print(result.error)
else:
    print(result.node_name)
💬

Need help with the API?

Open a support ticket or join the community discussion.

Contact Support