Skip to content

Core Module Settings



Attribute NameDefaultDescription
body Main module name
blkSide center Module side
alpha A Module's Alpha id


Attribute NameDefaultDescription
isFacial False Choose whether this module is marked as a facial module. This attribute is going to be used by the Picker and ModuleVisUI tools to seperate controls/modules in a Body group and a Facial group.
symmetryType 3 Choose the mirror type for right side controls
controlsMultiplier 2.0 Scale multiplier for this module's controls
alongSurface Input surface to attach all joints within this module to the selected surface when constructing the rig. NurbsSurface is recommended
doGimbleCtrls False Not implemented currently
doPivotCtrls False Not implemented currently
postSymmetryJntStruct False If this attribute is set to true, a joint structure re-build will be initiated after this module is symmetrized


Attribute NameDefaultDescription
interpJointsIsolatedCtrls False If this is checked ON, a control for each interpolated-joint within this module will be created.
interpJointsIsolatedControlShape circle The shape created for the isolated interpolation joints controls


Attribute NameDefaultDescription
doAttributeHostCtrl False If this is set to True, a new attribute host control will be created along with this module in the position set by it's guide. Depending on the module, all relevant custom channel box attributes/contrls will be created on it for the sake of order and coherence controling the module
attributeHostControlShape plus The shape created for the attribute host control
attrHostSpace The space of which the attribute host control will be parented to. This cannot be changed post construction.


Attribute NameDefaultDescription
spaces [' '] Drag and drop items to reorder. Depending on the module, all relevant space-switch controls will contain these spaces. Valid object types are Guides, Joints, and iterpJoints
splitOrientSpace False If this is set to True, all space switch attributes for this module will split into two spaces- Translate and Orient, for the animator to be able to set different space for tranlation and orientation.


Attribute NameDefaultDescription
colOverride False Override the main rig's color scheme for this module only
schemeOverride [(0.0, 1.0, 0.0), (0.15, 1.0, 0.15), (0.3, 1.0, 0.3), (0.45, 1.0, 0.45), (0.6, 1.0, 0.6)] Override with these colors


Attribute NameDefaultDescription
extraChannels Use this UI to create custom attributes within your modules and automatically connect to an attribute.