BipedPlus API (Beta)
/
Getting Started
Getting Started
Download MarkdownSwitch the Listener to Python and paste. The tool must already be installed.
Opens only on a verified Basic license. Trial, Player, and signed-out sessions raise PermissionError.
from os_bipedPlus import openAPI
api = openAPI()
Use api to pick a rig, then call work on the returned rig. There is no api.reset(). Use rig.reset().
Find
If the scene has one rig, this is enough.
rig = api.scan()
print(rig.com, rig.namespace)
If there are several, select that biped in the viewport, then call scan(). For the full list, see scan_all.
Build
rig = api.build(height_cm=170, engine_type="unreal")
Height is in centimeters. Engine is "unreal" or "unity". Omitted options use the tool defaults. See build.
Reset
rig.reset("all")
"all" restores both the biped and the controllers. Other modes are on reset.
What sits on each object
api
scan_allscanbuildupdate_ui
rig
inspectresetmirrorflipupdate_initrig.comis the biped name.namespace,info, andtop_grpare there too.