Core

class BuildCoreHierarchyAction

Bases: BuildAction

Build the core hierarchy of the rig.

This creates a group for one of the rig’s main features (usually ctls, joints, or meshes) and parents the corresponding nodes to it.

get_unorganized_nodes()

Return all nodes in the scene that aren’t already in the rig, and aren’t default scene nodes.

run()

Perform the main functionality of this build action. Attribute values can be accessed using self.myAttr.

class CreateRigAction

Bases: BuildAction

Create the main rig node.

run()

Perform the main functionality of this build action. Attribute values can be accessed using self.myAttr.

should_abort_on_error() → bool

Should the build be aborted if an error occurs while this action is running?

class DisplayLayerAction

Bases: BuildAction

Create a display layer.

run()

Perform the main functionality of this build action. Attribute values can be accessed using self.myAttr.

class ImportReferencesAction

Bases: BuildAction

Import all file references into the scene.

run()

Perform the main functionality of this build action. Attribute values can be accessed using self.myAttr.

class LockNodeAction

Bases: BuildAction

Lock some attributes of a node, and optionally hide it.

run()

Perform the main functionality of this build action. Attribute values can be accessed using self.myAttr.

class ObjectSetAction

Bases: BuildAction

Create an object set.

run()

Perform the main functionality of this build action. Attribute values can be accessed using self.myAttr.

class OptimizeSceneAction

Bases: BuildAction

Run scene optimization, deleting unused nodes.

There is currently no way to control which optimizations are run.

run()

Perform the main functionality of this build action. Attribute values can be accessed using self.myAttr.

class RenameSceneAction

Bases: BuildAction

Rename the current scene for building. Should be performed before all other actions.

Renaming the scene prevents accidentally saving the blueprint scene after failed builds or other modifications are made. The new scene acts as a sandbox for destructive operations and allows one-click re-opening of the blueprint scene in order to revert the build.

run()

Perform the main functionality of this build action. Attribute values can be accessed using self.myAttr.

should_abort_on_error() → bool

Abort the build if this action fails to preserve the blueprint scene.