BipedPlus API (Beta) / API Reference / Scene

scan()

Download Markdown

Returns the one rig to work on.

One rig in the scene: that rig. Several: the selected biped, or the rig the tool window is looking at.

Signature

api.scan() -> rig

No arguments.

Return

One rig. Fields match scan_all.

ValueError when there is no rig, or more than one and none can be chosen. Select a biped, or pick from scan_all.

Example

from os_bipedPlus import openAPI

api = openAPI()
rig = api.scan()
print(rig.info)

💬

Need help with the API?

Open a support ticket or join the community discussion.

Contact Support