Properties

Complete reference for all property groups defined by the Character Control Rig addon.

Scene Properties

props = context.scene.character_control_rig

Property	Blender Type	Default	Description
`selected_rig_instance_index`	`IntProperty`	—	Proxied to Character DNA's `rig_instance_list_active_index`. Reading/writing this property reads/writes the DNA addon's selection index.
`framework`	`EnumProperty`	First registered	The rig generation framework to use. Items populated dynamically by `get_framework_enum_items()`.
`snap_bones_to_mesh`	`BoolProperty`	`True`	When enabled, snap head/finger/toe tip bone tails to body and head mesh vertex positions during metarig generation.
`rig_instance_proxies`	`CollectionProperty(type=RigInstanceProxy)`	Empty	Per-instance state tracking. One entry per rig instance that has a metarig or control rig.

Addon Preferences

CharacterControlRigAddonProperties

Base class mixed into the addon preferences. Not a PropertyGroup itself — used as a mixin for CharacterControlRigPreferences(CharacterControlRigAddonProperties, AddonPreferences).

Property	Blender Type	Default	Description
`metrics_collection`	`BoolProperty`	`False`	Allow anonymous usage metrics to be sent. Shown in addon preferences as "Allow Metrics Collection".

RigInstanceProxy

Per-rig-instance state tracked by the addon. One entry per rig instance that has a metarig or control rig. Stored in props.rig_states.

Local Properties

Property	Blender Type	Description
`metarig`	`PointerProperty`	Reference to the generated metarig armature object
`framework`	`EnumProperty`	Name of the rig framework used to create the metarig

Proxy Properties (forwarded to Character DNA RigInstance)

These properties use custom get/set callbacks to read from and write to the corresponding property on the Character DNA RigInstance. They do not store data locally — all reads and writes are forwarded via find_character_dna_rig_instance().

Property	Blender Type	Proxied Character DNA Property	Description
`rig_instance_name`	`StringProperty`	`RigInstance.name`	Unique instance identifier, used as namespace prefix
`auto_evaluate`	`BoolProperty`	`RigInstance.auto_evaluate`	Master toggle for automatic RigLogic evaluation
`evaluate_bones`	`BoolProperty`	`RigInstance.evaluate_bones`	Evaluate bone transforms during RigLogic evaluation
`evaluate_shape_keys`	`BoolProperty`	`RigInstance.evaluate_shape_keys`	Evaluate shape keys during RigLogic evaluation
`evaluate_texture_masks`	`BoolProperty`	`RigInstance.evaluate_texture_masks`	Evaluate texture masks during RigLogic evaluation
`evaluate_rbfs`	`BoolProperty`	`RigInstance.evaluate_rbfs`	Evaluate RBF solvers during RigLogic evaluation