Skip to content

Modules

Gabriel Reed edited this page Feb 13, 2024 · 1 revision

Arguments

  • rig - (rigsys.Rig) a reference to the Rig object. All modules require this so they can perform actions like parenting root nodes they create to the rig node
  • side - (str) a string evaluating to "L", "M", or "R". Only motion and utility modules make use of this by default
  • label - (str) a string representing the name of the module
  • buildOrder - (int) an integer that represents when the module should be built relative to other modules. This can be set to any valid integer value. Lower build orders will be built before higher build orders. (Note that setting build order to a negative number is technically allowed, but setting rig.build(buildOrder=-1) will cause ALL modules to be built. Since there are a lot of integer values in Python we encourage only using positive values as best practice.)
  • isMuted - (bool) defaults to False, a bool representing whether the module should be run when the rig's build() method is called.
  • mirror - (bool) defaults to False, a bool representing whether the module should be mirrored. Only motion and utility modules make use of this by default.
Clone this wiki locally