HumanoidRigDescription¶
Not yet Class
Stores the joint mapping, T-pose, and per-joint properties for a 22-joint bipedal character rig. Joints may be AnimationConstraint, Motor6D, or Bone instances.
Not implemented yet
This class exists in the current Roblox API but is not implemented in Nova yet. Scripts that reference it will fail at runtime.
0 Nova members · 137 modern Roblox members not implemented yet
Description¶
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.
Inheritance¶
Object → Instance → HumanoidRigDescription
Properties¶
| Member | Signature | Summary |
|---|---|---|
Chest |
Chest: Instance |
The chest joint instance in the rig hierarchy. |
ChestRangeMax |
ChestRangeMax: Vector3 |
Maximum rotation limit per axis for the chest joint. |
ChestRangeMin |
ChestRangeMin: Vector3 |
Minimum rotation limit per axis for the chest joint. |
ChestSize |
ChestSize: float |
Volume sphere diameter for the chest joint. |
ChestTposeAdjustment |
ChestTposeAdjustment: CFrame |
T-pose alignment transform for the chest joint. |
HeadBase |
HeadBase: Instance |
The head base joint instance in the rig hierarchy. |
HeadBaseRangeMax |
HeadBaseRangeMax: Vector3 |
Maximum rotation limit per axis for the head base joint. |
HeadBaseRangeMin |
HeadBaseRangeMin: Vector3 |
Minimum rotation limit per axis for the head base joint. |
HeadBaseSize |
HeadBaseSize: float |
Volume sphere diameter for the head base joint. |
HeadBaseTposeAdjustment |
HeadBaseTposeAdjustment: CFrame |
T-pose alignment transform for the head base joint. |
LeftAnkle |
LeftAnkle: Instance |
The left ankle joint instance in the rig hierarchy. |
LeftAnkleRangeMax |
LeftAnkleRangeMax: Vector3 |
Maximum rotation limit per axis for the left ankle joint. |
LeftAnkleRangeMin |
LeftAnkleRangeMin: Vector3 |
Minimum rotation limit per axis for the left ankle joint. |
LeftAnkleSize |
LeftAnkleSize: float |
Volume sphere diameter for the left ankle joint. |
LeftAnkleTposeAdjustment |
LeftAnkleTposeAdjustment: CFrame |
T-pose alignment transform for the left ankle joint. |
LeftClavicle |
LeftClavicle: Instance |
The left clavicle joint instance in the rig hierarchy. |
LeftClavicleRangeMax |
LeftClavicleRangeMax: Vector3 |
Maximum rotation limit per axis for the left clavicle joint. |
LeftClavicleRangeMin |
LeftClavicleRangeMin: Vector3 |
Minimum rotation limit per axis for the left clavicle joint. |
LeftClavicleSize |
LeftClavicleSize: float |
Volume sphere diameter for the left clavicle joint. |
LeftClavicleTposeAdjustment |
LeftClavicleTposeAdjustment: CFrame |
T-pose alignment transform for the left clavicle joint. |
LeftElbow |
LeftElbow: Instance |
The left elbow joint instance in the rig hierarchy. |
LeftElbowRangeMax |
LeftElbowRangeMax: Vector3 |
Maximum rotation limit per axis for the left elbow joint. |
LeftElbowRangeMin |
LeftElbowRangeMin: Vector3 |
Minimum rotation limit per axis for the left elbow joint. |
LeftElbowSize |
LeftElbowSize: float |
Volume sphere diameter for the left elbow joint. |
LeftElbowTposeAdjustment |
LeftElbowTposeAdjustment: CFrame |
T-pose alignment transform for the left elbow joint. |
LeftHip |
LeftHip: Instance |
The left hip joint instance in the rig hierarchy. |
LeftHipRangeMax |
LeftHipRangeMax: Vector3 |
Maximum rotation limit per axis for the left hip joint. |
LeftHipRangeMin |
LeftHipRangeMin: Vector3 |
Minimum rotation limit per axis for the left hip joint. |
LeftHipSize |
LeftHipSize: float |
Volume sphere diameter for the left hip joint. |
LeftHipTposeAdjustment |
LeftHipTposeAdjustment: CFrame |
T-pose alignment transform for the left hip joint. |
LeftKnee |
LeftKnee: Instance |
The left knee joint instance in the rig hierarchy. |
LeftKneeRangeMax |
LeftKneeRangeMax: Vector3 |
Maximum rotation limit per axis for the left knee joint. |
LeftKneeRangeMin |
LeftKneeRangeMin: Vector3 |
Minimum rotation limit per axis for the left knee joint. |
LeftKneeSize |
LeftKneeSize: float |
Volume sphere diameter for the left knee joint. |
LeftKneeTposeAdjustment |
LeftKneeTposeAdjustment: CFrame |
T-pose alignment transform for the left knee joint. |
LeftShoulder |
LeftShoulder: Instance |
The left shoulder joint instance in the rig hierarchy. |
LeftShoulderRangeMax |
LeftShoulderRangeMax: Vector3 |
Maximum rotation limit per axis for the left shoulder joint. |
LeftShoulderRangeMin |
LeftShoulderRangeMin: Vector3 |
Minimum rotation limit per axis for the left shoulder joint. |
LeftShoulderSize |
LeftShoulderSize: float |
Volume sphere diameter for the left shoulder joint. |
LeftShoulderTposeAdjustment |
LeftShoulderTposeAdjustment: CFrame |
T-pose alignment transform for the left shoulder joint. |
LeftToeBase |
LeftToeBase: Instance |
The left toe base joint instance in the rig hierarchy. |
LeftToeBaseRangeMax |
LeftToeBaseRangeMax: Vector3 |
Maximum rotation limit per axis for the left toe base joint. |
LeftToeBaseRangeMin |
LeftToeBaseRangeMin: Vector3 |
Minimum rotation limit per axis for the left toe base joint. |
LeftToeBaseSize |
LeftToeBaseSize: float |
Volume sphere diameter for the left toe base joint. |
LeftToeBaseTposeAdjustment |
LeftToeBaseTposeAdjustment: CFrame |
T-pose alignment transform for the left toe base joint. |
LeftWrist |
LeftWrist: Instance |
The left wrist joint instance in the rig hierarchy. |
LeftWristRangeMax |
LeftWristRangeMax: Vector3 |
Maximum rotation limit per axis for the left wrist joint. |
LeftWristRangeMin |
LeftWristRangeMin: Vector3 |
Minimum rotation limit per axis for the left wrist joint. |
LeftWristSize |
LeftWristSize: float |
Volume sphere diameter for the left wrist joint. |
LeftWristTposeAdjustment |
LeftWristTposeAdjustment: CFrame |
T-pose alignment transform for the left wrist joint. |
Neck |
Neck: Instance |
The neck joint instance in the rig hierarchy. |
NeckRangeMax |
NeckRangeMax: Vector3 |
Maximum rotation limit per axis for the neck joint. |
NeckRangeMin |
NeckRangeMin: Vector3 |
Minimum rotation limit per axis for the neck joint. |
NeckSize |
NeckSize: float |
Volume sphere diameter for the neck joint. |
NeckTposeAdjustment |
NeckTposeAdjustment: CFrame |
T-pose alignment transform for the neck joint. |
OriginOffset |
OriginOffset: CFrame |
Offset of the rig origin from the character model's primary part. |
RightAnkle |
RightAnkle: Instance |
The right ankle joint instance in the rig hierarchy. |
RightAnkleRangeMax |
RightAnkleRangeMax: Vector3 |
Maximum rotation limit per axis for the right ankle joint. |
RightAnkleRangeMin |
RightAnkleRangeMin: Vector3 |
Minimum rotation limit per axis for the right ankle joint. |
RightAnkleSize |
RightAnkleSize: float |
Volume sphere diameter for the right ankle joint. |
RightAnkleTposeAdjustment |
RightAnkleTposeAdjustment: CFrame |
T-pose alignment transform for the right ankle joint. |
RightClavicle |
RightClavicle: Instance |
The right clavicle joint instance in the rig hierarchy. |
RightClavicleRangeMax |
RightClavicleRangeMax: Vector3 |
Maximum rotation limit per axis for the right clavicle joint. |
RightClavicleRangeMin |
RightClavicleRangeMin: Vector3 |
Minimum rotation limit per axis for the right clavicle joint. |
RightClavicleSize |
RightClavicleSize: float |
Volume sphere diameter for the right clavicle joint. |
RightClavicleTposeAdjustment |
RightClavicleTposeAdjustment: CFrame |
T-pose alignment transform for the right clavicle joint. |
RightElbow |
RightElbow: Instance |
The right elbow joint instance in the rig hierarchy. |
RightElbowRangeMax |
RightElbowRangeMax: Vector3 |
Maximum rotation limit per axis for the right elbow joint. |
RightElbowRangeMin |
RightElbowRangeMin: Vector3 |
Minimum rotation limit per axis for the right elbow joint. |
RightElbowSize |
RightElbowSize: float |
Volume sphere diameter for the right elbow joint. |
RightElbowTposeAdjustment |
RightElbowTposeAdjustment: CFrame |
T-pose alignment transform for the right elbow joint. |
RightHip |
RightHip: Instance |
The right hip joint instance in the rig hierarchy. |
RightHipRangeMax |
RightHipRangeMax: Vector3 |
Maximum rotation limit per axis for the right hip joint. |
RightHipRangeMin |
RightHipRangeMin: Vector3 |
Minimum rotation limit per axis for the right hip joint. |
RightHipSize |
RightHipSize: float |
Volume sphere diameter for the right hip joint. |
RightHipTposeAdjustment |
RightHipTposeAdjustment: CFrame |
T-pose alignment transform for the right hip joint. |
RightKnee |
RightKnee: Instance |
The right knee joint instance in the rig hierarchy. |
RightKneeRangeMax |
RightKneeRangeMax: Vector3 |
Maximum rotation limit per axis for the right knee joint. |
RightKneeRangeMin |
RightKneeRangeMin: Vector3 |
Minimum rotation limit per axis for the right knee joint. |
RightKneeSize |
RightKneeSize: float |
Volume sphere diameter for the right knee joint. |
RightKneeTposeAdjustment |
RightKneeTposeAdjustment: CFrame |
T-pose alignment transform for the right knee joint. |
RightShoulder |
RightShoulder: Instance |
The right shoulder joint instance in the rig hierarchy. |
RightShoulderRangeMax |
RightShoulderRangeMax: Vector3 |
Maximum rotation limit per axis for the right shoulder joint. |
RightShoulderRangeMin |
RightShoulderRangeMin: Vector3 |
Minimum rotation limit per axis for the right shoulder joint. |
RightShoulderSize |
RightShoulderSize: float |
Volume sphere diameter for the right shoulder joint. |
RightShoulderTposeAdjustment |
RightShoulderTposeAdjustment: CFrame |
T-pose alignment transform for the right shoulder joint. |
RightToeBase |
RightToeBase: Instance |
The right toe base joint instance in the rig hierarchy. |
RightToeBaseRangeMax |
RightToeBaseRangeMax: Vector3 |
Maximum rotation limit per axis for the right toe base joint. |
RightToeBaseRangeMin |
RightToeBaseRangeMin: Vector3 |
Minimum rotation limit per axis for the right toe base joint. |
RightToeBaseSize |
RightToeBaseSize: float |
Volume sphere diameter for the right toe base joint. |
RightToeBaseTposeAdjustment |
RightToeBaseTposeAdjustment: CFrame |
T-pose alignment transform for the right toe base joint. |
RightWrist |
RightWrist: Instance |
The right wrist joint instance in the rig hierarchy. |
RightWristRangeMax |
RightWristRangeMax: Vector3 |
Maximum rotation limit per axis for the right wrist joint. |
RightWristRangeMin |
RightWristRangeMin: Vector3 |
Minimum rotation limit per axis for the right wrist joint. |
RightWristSize |
RightWristSize: float |
Volume sphere diameter for the right wrist joint. |
RightWristTposeAdjustment |
RightWristTposeAdjustment: CFrame |
T-pose alignment transform for the right wrist joint. |
Root |
Root: Instance |
The root joint instance in the rig hierarchy. |
RootRangeMax |
RootRangeMax: Vector3 |
Maximum rotation limit per axis for the root joint. |
RootRangeMin |
RootRangeMin: Vector3 |
Minimum rotation limit per axis for the root joint. |
RootSize |
RootSize: float |
Volume sphere diameter for the root joint. |
RootTposeAdjustment |
RootTposeAdjustment: CFrame |
T-pose alignment transform for the root joint. |
Spine |
Spine: Instance |
The spine joint instance in the rig hierarchy. |
SpineRangeMax |
SpineRangeMax: Vector3 |
Maximum rotation limit per axis for the spine joint. |
SpineRangeMin |
SpineRangeMin: Vector3 |
Minimum rotation limit per axis for the spine joint. |
SpineSize |
SpineSize: float |
Volume sphere diameter for the spine joint. |
SpineTposeAdjustment |
SpineTposeAdjustment: CFrame |
T-pose alignment transform for the spine joint. |
Waist |
Waist: Instance |
The waist joint instance in the rig hierarchy. |
WaistRangeMax |
WaistRangeMax: Vector3 |
Maximum rotation limit per axis for the waist joint. |
WaistRangeMin |
WaistRangeMin: Vector3 |
Minimum rotation limit per axis for the waist joint. |
WaistSize |
WaistSize: float |
Volume sphere diameter for the waist joint. |
WaistTposeAdjustment |
WaistTposeAdjustment: CFrame |
T-pose alignment transform for the waist joint. |
Methods¶
| Member | Signature | Summary |
|---|---|---|
AutoRig |
HumanoidRigDescription:AutoRig(character: Instance): null |
— |
GetContainedJointLabels |
HumanoidRigDescription:GetContainedJointLabels(bodyMeshPartName: string): Array |
— |
GetJoint |
HumanoidRigDescription:GetJoint(label: RigLabel): Instance |
— |
GetJointFromName |
HumanoidRigDescription:GetJointFromName(name: string): Instance |
Returns the joint instance associated with the given name string. |
GetJointLabels |
HumanoidRigDescription:GetJointLabels(): Array |
— |
GetJointNames |
HumanoidRigDescription:GetJointNames(): Array |
Returns the full set of 22 standard joint names in hierarchy order. |
GetJointRangeMax |
HumanoidRigDescription:GetJointRangeMax(rigLabel: RigLabel): Vector3 |
— |
GetJointRangeMin |
HumanoidRigDescription:GetJointRangeMin(rigLabel: RigLabel): Vector3 |
— |
GetJointSize |
HumanoidRigDescription:GetJointSize(label: RigLabel): float |
— |
GetR15JointLabels |
HumanoidRigDescription:GetR15JointLabels(): Array |
— |
GetR15JointNames |
HumanoidRigDescription:GetR15JointNames(): Array |
Returns the 15 joint names used by R15 rigs. |
GetR6JointLabels |
HumanoidRigDescription:GetR6JointLabels(): Array |
— |
GetR6JointNames |
HumanoidRigDescription:GetR6JointNames(): Array |
Returns the 6 joint names used by R6 rigs. |
GetTposeAdjustment |
HumanoidRigDescription:GetTposeAdjustment(label: RigLabel): CFrame |
— |
SetJoint |
HumanoidRigDescription:SetJoint(label: RigLabel, joint: Instance): null |
— |
SetJointRangeMax |
HumanoidRigDescription:SetJointRangeMax(rigLabel: RigLabel, rangeMax: Vector3): null |
— |
SetJointRangeMin |
HumanoidRigDescription:SetJointRangeMin(rigLabel: RigLabel, rangeMin: Vector3): null |
— |
SetJointSize |
HumanoidRigDescription:SetJointSize(label: RigLabel, size: float): null |
— |
SetTposeAdjustment |
HumanoidRigDescription:SetTposeAdjustment(label: RigLabel, transform: CFrame): null |
— |
ShowVolumes |
HumanoidRigDescription:ShowVolumes(show: bool): null |
— |
Roblox reference: HumanoidRigDescription
Generated from Nova's API dump and Roblox creator-docs. Nova-only members come from the engine's reflection metadata.