Stores the joint mapping, reference T-pose and per-joint properties for a bipedal Humanoid character rig. Each of the 22 joints in the rig hierarchy can reference an Instance (typically a Motor6D, AnimationConstraint or Bone), define a T-pose adjustment transform, rotation range limits, and carry a size for volumetric visualization and retargeting. For an example Blender and Maya rig hierarchy with all optional joints, see Character specifications - Advanced R15 rigs.
Use AutoRig to automatically populate joint references from a character model, or assign joints individually. Supports both R6 (6-joint) and R15 (15-joint) rig subsets in addition to the full 22-joint standard set, as well as rigs with more than 22 joints by mapping the key subset of joints.
The Motor6D, AnimationConstraint, or Bone joint instance for the chest joint. This joint is the branch point for the neck chain and both clavicle chains.
Field
Value
type
Instance
security
{"read":"None","write":"None"}
thread safety
ReadSafe
category
Mapping
serialization
{"can_load":true,"can_save":true}
capabilities
["Animation"]
HumanoidRigDescription.ChestRangeMax
Maximum rotation range in degrees for the chest joint along each local axis (X, Y, Z).
Field
Value
type
Vector3
security
{"read":"None","write":"None"}
thread safety
ReadSafe
category
Range
serialization
{"can_load":true,"can_save":true}
capabilities
["Animation"]
HumanoidRigDescription.ChestRangeMin
Minimum rotation range in degrees for the chest joint along each local axis (X, Y, Z).
Field
Value
type
Vector3
security
{"read":"None","write":"None"}
thread safety
ReadSafe
category
Range
serialization
{"can_load":true,"can_save":true}
capabilities
["Animation"]
HumanoidRigDescription.ChestSize
Size of the chest joint's volume sphere, used for rig visualization and collision.
Field
Value
type
float
security
{"read":"None","write":"None"}
thread safety
ReadSafe
category
Size
serialization
{"can_load":true,"can_save":true}
capabilities
["Animation"]
HumanoidRigDescription.ChestTposeAdjustment
Coordinate frame adjustment applied to the chest joint to align it with the T-pose reference orientation.
Field
Value
type
CFrame
security
{"read":"None","write":"None"}
thread safety
ReadSafe
category
Tpose
serialization
{"can_load":true,"can_save":true}
capabilities
["Animation"]
HumanoidRigDescription.HeadBase
The Motor6D, AnimationConstraint, or Bone joint instance for the head base joint. This is the terminal joint of the head chain.
Field
Value
type
Instance
security
{"read":"None","write":"None"}
thread safety
ReadSafe
category
Mapping
serialization
{"can_load":true,"can_save":true}
capabilities
["Animation"]
HumanoidRigDescription.HeadBaseRangeMax
Maximum rotation range in degrees for the head base joint along each local axis (X, Y, Z).
Field
Value
type
Vector3
security
{"read":"None","write":"None"}
thread safety
ReadSafe
category
Range
serialization
{"can_load":true,"can_save":true}
capabilities
["Animation"]
HumanoidRigDescription.HeadBaseRangeMin
Minimum rotation range in degrees for the head base joint along each local axis (X, Y, Z).
Field
Value
type
Vector3
security
{"read":"None","write":"None"}
thread safety
ReadSafe
category
Range
serialization
{"can_load":true,"can_save":true}
capabilities
["Animation"]
HumanoidRigDescription.HeadBaseSize
Diameter of the head base joint's volume sphere, used for rig visualization and collision.
Field
Value
type
float
security
{"read":"None","write":"None"}
thread safety
ReadSafe
category
Size
serialization
{"can_load":true,"can_save":true}
capabilities
["Animation"]
HumanoidRigDescription.HeadBaseTposeAdjustment
Coordinate frame adjustment applied to the head base joint to align it with the T-pose reference orientation.
Maximum rotation range in degrees for the neck joint along each local axis (X, Y, Z).
Field
Value
type
Vector3
security
{"read":"None","write":"None"}
thread safety
ReadSafe
category
Range
serialization
{"can_load":true,"can_save":true}
capabilities
["Animation"]
HumanoidRigDescription.NeckRangeMin
Minimum rotation range in degrees for the neck joint along each local axis (X, Y, Z).
Field
Value
type
Vector3
security
{"read":"None","write":"None"}
thread safety
ReadSafe
category
Range
serialization
{"can_load":true,"can_save":true}
capabilities
["Animation"]
HumanoidRigDescription.NeckSize
Diameter of the neck joint's volume sphere, used for rig visualization and collision.
Field
Value
type
float
security
{"read":"None","write":"None"}
thread safety
ReadSafe
category
Size
serialization
{"can_load":true,"can_save":true}
capabilities
["Animation"]
HumanoidRigDescription.NeckTposeAdjustment
Coordinate frame adjustment applied to the neck joint to align it with the T-pose reference orientation.
Field
Value
type
CFrame
security
{"read":"None","write":"None"}
thread safety
ReadSafe
category
Tpose
serialization
{"can_load":true,"can_save":true}
capabilities
["Animation"]
HumanoidRigDescription.OriginOffset
Coordinate frame offset of the rig origin relative to the character model's primary part. Adjusts where the rig hierarchy is anchored within the character.
Coordinate frame adjustment applied to the right toe base joint to align it with the T-pose reference orientation.
Field
Value
type
CFrame
security
{"read":"None","write":"None"}
thread safety
ReadSafe
category
Tpose
serialization
{"can_load":true,"can_save":true}
capabilities
["Animation"]
HumanoidRigDescription.RightWrist
The Motor6D, AnimationConstraint, or Bone joint instance for the right wrist joint. This is the terminal joint of the right arm chain.
Field
Value
type
Instance
security
{"read":"None","write":"None"}
thread safety
ReadSafe
category
Mapping
serialization
{"can_load":true,"can_save":true}
capabilities
["Animation"]
HumanoidRigDescription.RightWristRangeMax
Maximum rotation range in degrees for the right wrist joint along each local axis (X, Y, Z).
Field
Value
type
Vector3
security
{"read":"None","write":"None"}
thread safety
ReadSafe
category
Range
serialization
{"can_load":true,"can_save":true}
capabilities
["Animation"]
HumanoidRigDescription.RightWristRangeMin
Minimum rotation range in degrees for the right wrist joint along each local axis (X, Y, Z).
Field
Value
type
Vector3
security
{"read":"None","write":"None"}
thread safety
ReadSafe
category
Range
serialization
{"can_load":true,"can_save":true}
capabilities
["Animation"]
HumanoidRigDescription.RightWristSize
Diameter of the right wrist joint's volume sphere, used for rig visualization and collision.
Field
Value
type
float
security
{"read":"None","write":"None"}
thread safety
ReadSafe
category
Size
serialization
{"can_load":true,"can_save":true}
capabilities
["Animation"]
HumanoidRigDescription.RightWristTposeAdjustment
Coordinate frame adjustment applied to the right wrist joint to align it with the T-pose reference orientation.
Field
Value
type
CFrame
security
{"read":"None","write":"None"}
thread safety
ReadSafe
category
Tpose
serialization
{"can_load":true,"can_save":true}
capabilities
["Animation"]
HumanoidRigDescription.Root
The Motor6D, AnimationConstraint, or Bone joint instance for the root joint, which is the base of the entire rig hierarchy. The waist, left hip, and right hip chains all originate from this joint.
Field
Value
type
Instance
security
{"read":"None","write":"None"}
thread safety
ReadSafe
category
Mapping
serialization
{"can_load":true,"can_save":true}
capabilities
["Animation"]
HumanoidRigDescription.RootRangeMax
Maximum rotation range in degrees for the root joint along each local axis (X, Y, Z).
Field
Value
type
Vector3
security
{"read":"None","write":"None"}
thread safety
ReadSafe
category
Range
serialization
{"can_load":true,"can_save":true}
capabilities
["Animation"]
HumanoidRigDescription.RootRangeMin
Minimum rotation range in degrees for the root joint along each local axis (X, Y, Z).
Field
Value
type
Vector3
security
{"read":"None","write":"None"}
thread safety
ReadSafe
category
Range
serialization
{"can_load":true,"can_save":true}
capabilities
["Animation"]
HumanoidRigDescription.RootSize
Diameter of the root joint's volume sphere, used for rig visualization and collision.
Field
Value
type
float
security
{"read":"None","write":"None"}
thread safety
ReadSafe
category
Size
serialization
{"can_load":true,"can_save":true}
capabilities
["Animation"]
HumanoidRigDescription.RootTposeAdjustment
Coordinate frame adjustment applied to the root joint to align it with the T-pose reference orientation.
Returns the joint instance associated with the given joint name. Accepts both standard joint names (e.g., "LeftShoulder") and R15 body part names (e.g., "LeftLowerLeg"). Name matching is case-insensitive. Returns nil if no joint with the given name is mapped.
Parameters
Name
Type
Default
Description
name
string
string
Returns
Type
Description
Instance
Instance
Field
Value
security
None
thread safety
Safe
capabilities
["Animation"]
HumanoidRigDescription:GetJointNames
Returns an array of all 22 standard joint name strings for this rig description, in hierarchy order: Root, Waist, Spine, Chest, Neck, HeadBase, LeftClavicle, LeftShoulder, LeftElbow, LeftWrist, RightClavicle, RightShoulder, RightElbow, RightWrist, LeftHip, LeftKnee, LeftAnkle, LeftToeBase, RightHip, RightKnee, RightAnkle, RightToeBase.
Returns
Type
Description
Array
Array
Field
Value
security
None
thread safety
Safe
capabilities
["Animation"]
HumanoidRigDescription:GetR15JointNames
Returns an array of the 15 joint name strings used by R15 rigs: Root, Waist, Neck, LeftShoulder, LeftElbow, LeftWrist, RightShoulder, RightElbow, RightWrist, LeftHip, LeftKnee, LeftAnkle, RightHip, RightKnee, RightAnkle.
Returns
Type
Description
Array
Array
Field
Value
security
None
thread safety
Safe
capabilities
["Animation"]
HumanoidRigDescription:GetR6JointNames
Returns an array of the 6 joint name strings used by R6 rigs: Root, Neck, LeftShoulder, RightShoulder, LeftHip, RightHip.