Roblox UtilitiesDevlHub Roblox Documentation

Class

HumanoidRigDescription

Inherits
Instance › Object
Memory category
Animation

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.

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.

Properties 111#

ChestInstanceThe chest joint instance in the rig hierarchy.ReadSafe
ChestRangeMaxVector3Maximum rotation limit per axis for the chest joint.ReadSafe
ChestRangeMinVector3Minimum rotation limit per axis for the chest joint.ReadSafe
ChestSizefloatVolume sphere diameter for the chest joint.ReadSafe
ChestTposeAdjustmentCFrameT-pose alignment transform for the chest joint.ReadSafe
HeadBaseInstanceThe head base joint instance in the rig hierarchy.ReadSafe
HeadBaseRangeMaxVector3Maximum rotation limit per axis for the head base joint.ReadSafe
HeadBaseRangeMinVector3Minimum rotation limit per axis for the head base joint.ReadSafe
HeadBaseSizefloatVolume sphere diameter for the head base joint.ReadSafe
HeadBaseTposeAdjustmentCFrameT-pose alignment transform for the head base joint.ReadSafe
LeftAnkleInstanceThe left ankle joint instance in the rig hierarchy.ReadSafe
LeftAnkleRangeMaxVector3Maximum rotation limit per axis for the left ankle joint.ReadSafe
LeftAnkleRangeMinVector3Minimum rotation limit per axis for the left ankle joint.ReadSafe
LeftAnkleSizefloatVolume sphere diameter for the left ankle joint.ReadSafe
LeftAnkleTposeAdjustmentCFrameT-pose alignment transform for the left ankle joint.ReadSafe
LeftClavicleInstanceThe left clavicle joint instance in the rig hierarchy.ReadSafe
LeftClavicleRangeMaxVector3Maximum rotation limit per axis for the left clavicle joint.ReadSafe
LeftClavicleRangeMinVector3Minimum rotation limit per axis for the left clavicle joint.ReadSafe
LeftClavicleSizefloatVolume sphere diameter for the left clavicle joint.ReadSafe
LeftClavicleTposeAdjustmentCFrameT-pose alignment transform for the left clavicle joint.ReadSafe
LeftElbowInstanceThe left elbow joint instance in the rig hierarchy.ReadSafe
LeftElbowRangeMaxVector3Maximum rotation limit per axis for the left elbow joint.ReadSafe
LeftElbowRangeMinVector3Minimum rotation limit per axis for the left elbow joint.ReadSafe
LeftElbowSizefloatVolume sphere diameter for the left elbow joint.ReadSafe
LeftElbowTposeAdjustmentCFrameT-pose alignment transform for the left elbow joint.ReadSafe
LeftHipInstanceThe left hip joint instance in the rig hierarchy.ReadSafe
LeftHipRangeMaxVector3Maximum rotation limit per axis for the left hip joint.ReadSafe
LeftHipRangeMinVector3Minimum rotation limit per axis for the left hip joint.ReadSafe
LeftHipSizefloatVolume sphere diameter for the left hip joint.ReadSafe
LeftHipTposeAdjustmentCFrameT-pose alignment transform for the left hip joint.ReadSafe
LeftKneeInstanceThe left knee joint instance in the rig hierarchy.ReadSafe
LeftKneeRangeMaxVector3Maximum rotation limit per axis for the left knee joint.ReadSafe
LeftKneeRangeMinVector3Minimum rotation limit per axis for the left knee joint.ReadSafe
LeftKneeSizefloatVolume sphere diameter for the left knee joint.ReadSafe
LeftKneeTposeAdjustmentCFrameT-pose alignment transform for the left knee joint.ReadSafe
LeftShoulderInstanceThe left shoulder joint instance in the rig hierarchy.ReadSafe
LeftShoulderRangeMaxVector3Maximum rotation limit per axis for the left shoulder joint.ReadSafe
LeftShoulderRangeMinVector3Minimum rotation limit per axis for the left shoulder joint.ReadSafe
LeftShoulderSizefloatVolume sphere diameter for the left shoulder joint.ReadSafe
LeftShoulderTposeAdjustmentCFrameT-pose alignment transform for the left shoulder joint.ReadSafe
LeftToeBaseInstanceThe left toe base joint instance in the rig hierarchy.ReadSafe
LeftToeBaseRangeMaxVector3Maximum rotation limit per axis for the left toe base joint.ReadSafe
LeftToeBaseRangeMinVector3Minimum rotation limit per axis for the left toe base joint.ReadSafe
LeftToeBaseSizefloatVolume sphere diameter for the left toe base joint.ReadSafe
LeftToeBaseTposeAdjustmentCFrameT-pose alignment transform for the left toe base joint.ReadSafe
LeftWristInstanceThe left wrist joint instance in the rig hierarchy.ReadSafe
LeftWristRangeMaxVector3Maximum rotation limit per axis for the left wrist joint.ReadSafe
LeftWristRangeMinVector3Minimum rotation limit per axis for the left wrist joint.ReadSafe
LeftWristSizefloatVolume sphere diameter for the left wrist joint.ReadSafe
LeftWristTposeAdjustmentCFrameT-pose alignment transform for the left wrist joint.ReadSafe
NeckInstanceThe neck joint instance in the rig hierarchy.ReadSafe
NeckRangeMaxVector3Maximum rotation limit per axis for the neck joint.ReadSafe
NeckRangeMinVector3Minimum rotation limit per axis for the neck joint.ReadSafe
NeckSizefloatVolume sphere diameter for the neck joint.ReadSafe
NeckTposeAdjustmentCFrameT-pose alignment transform for the neck joint.ReadSafe
OriginOffsetCFrameOffset of the rig origin from the character model's primary part.ReadSafe
RightAnkleInstanceThe right ankle joint instance in the rig hierarchy.ReadSafe
RightAnkleRangeMaxVector3Maximum rotation limit per axis for the right ankle joint.ReadSafe
RightAnkleRangeMinVector3Minimum rotation limit per axis for the right ankle joint.ReadSafe
RightAnkleSizefloatVolume sphere diameter for the right ankle joint.ReadSafe
RightAnkleTposeAdjustmentCFrameT-pose alignment transform for the right ankle joint.ReadSafe
RightClavicleInstanceThe right clavicle joint instance in the rig hierarchy.ReadSafe
RightClavicleRangeMaxVector3Maximum rotation limit per axis for the right clavicle joint.ReadSafe
RightClavicleRangeMinVector3Minimum rotation limit per axis for the right clavicle joint.ReadSafe
RightClavicleSizefloatVolume sphere diameter for the right clavicle joint.ReadSafe
RightClavicleTposeAdjustmentCFrameT-pose alignment transform for the right clavicle joint.ReadSafe
RightElbowInstanceThe right elbow joint instance in the rig hierarchy.ReadSafe
RightElbowRangeMaxVector3Maximum rotation limit per axis for the right elbow joint.ReadSafe
RightElbowRangeMinVector3Minimum rotation limit per axis for the right elbow joint.ReadSafe
RightElbowSizefloatVolume sphere diameter for the right elbow joint.ReadSafe
RightElbowTposeAdjustmentCFrameT-pose alignment transform for the right elbow joint.ReadSafe
RightHipInstanceThe right hip joint instance in the rig hierarchy.ReadSafe
RightHipRangeMaxVector3Maximum rotation limit per axis for the right hip joint.ReadSafe
RightHipRangeMinVector3Minimum rotation limit per axis for the right hip joint.ReadSafe
RightHipSizefloatVolume sphere diameter for the right hip joint.ReadSafe
RightHipTposeAdjustmentCFrameT-pose alignment transform for the right hip joint.ReadSafe
RightKneeInstanceThe right knee joint instance in the rig hierarchy.ReadSafe
RightKneeRangeMaxVector3Maximum rotation limit per axis for the right knee joint.ReadSafe
RightKneeRangeMinVector3Minimum rotation limit per axis for the right knee joint.ReadSafe
RightKneeSizefloatVolume sphere diameter for the right knee joint.ReadSafe
RightKneeTposeAdjustmentCFrameT-pose alignment transform for the right knee joint.ReadSafe
RightShoulderInstanceThe right shoulder joint instance in the rig hierarchy.ReadSafe
RightShoulderRangeMaxVector3Maximum rotation limit per axis for the right shoulder joint.ReadSafe
RightShoulderRangeMinVector3Minimum rotation limit per axis for the right shoulder joint.ReadSafe
RightShoulderSizefloatVolume sphere diameter for the right shoulder joint.ReadSafe
RightShoulderTposeAdjustmentCFrameT-pose alignment transform for the right shoulder joint.ReadSafe
RightToeBaseInstanceThe right toe base joint instance in the rig hierarchy.ReadSafe
RightToeBaseRangeMaxVector3Maximum rotation limit per axis for the right toe base joint.ReadSafe
RightToeBaseRangeMinVector3Minimum rotation limit per axis for the right toe base joint.ReadSafe
RightToeBaseSizefloatVolume sphere diameter for the right toe base joint.ReadSafe
RightToeBaseTposeAdjustmentCFrameT-pose alignment transform for the right toe base joint.ReadSafe
RightWristInstanceThe right wrist joint instance in the rig hierarchy.ReadSafe
RightWristRangeMaxVector3Maximum rotation limit per axis for the right wrist joint.ReadSafe
RightWristRangeMinVector3Minimum rotation limit per axis for the right wrist joint.ReadSafe
RightWristSizefloatVolume sphere diameter for the right wrist joint.ReadSafe
RightWristTposeAdjustmentCFrameT-pose alignment transform for the right wrist joint.ReadSafe
RootInstanceThe root joint instance in the rig hierarchy.ReadSafe
RootRangeMaxVector3Maximum rotation limit per axis for the root joint.ReadSafe
RootRangeMinVector3Minimum rotation limit per axis for the root joint.ReadSafe
RootSizefloatVolume sphere diameter for the root joint.ReadSafe
RootTposeAdjustmentCFrameT-pose alignment transform for the root joint.ReadSafe
SpineInstanceThe spine joint instance in the rig hierarchy.ReadSafe
SpineRangeMaxVector3Maximum rotation limit per axis for the spine joint.ReadSafe
SpineRangeMinVector3Minimum rotation limit per axis for the spine joint.ReadSafe
SpineSizefloatVolume sphere diameter for the spine joint.ReadSafe
SpineTposeAdjustmentCFrameT-pose alignment transform for the spine joint.ReadSafe
WaistInstanceThe waist joint instance in the rig hierarchy.ReadSafe
WaistRangeMaxVector3Maximum rotation limit per axis for the waist joint.ReadSafe
WaistRangeMinVector3Minimum rotation limit per axis for the waist joint.ReadSafe
WaistSizefloatVolume sphere diameter for the waist joint.ReadSafe
WaistTposeAdjustmentCFrameT-pose alignment transform for the waist joint.ReadSafe

Chest: Instance#

ReadSafe

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.

ChestRangeMax: Vector3#

ReadSafe

Maximum rotation range in degrees for the chest joint along each local axis (X, Y, Z).

ChestRangeMin: Vector3#

ReadSafe

Minimum rotation range in degrees for the chest joint along each local axis (X, Y, Z).

ChestSize: float#

ReadSafe

Size of the chest joint's volume sphere, used for rig visualization and collision.

ChestTposeAdjustment: CFrame#

ReadSafe

Coordinate frame adjustment applied to the chest joint to align it with the T-pose reference orientation.

HeadBase: Instance#

ReadSafe

The Motor6D, AnimationConstraint, or Bone joint instance for the head base joint. This is the terminal joint of the head chain.

HeadBaseRangeMax: Vector3#

ReadSafe

Maximum rotation range in degrees for the head base joint along each local axis (X, Y, Z).

HeadBaseRangeMin: Vector3#

ReadSafe

Minimum rotation range in degrees for the head base joint along each local axis (X, Y, Z).

HeadBaseSize: float#

ReadSafe

Diameter of the head base joint's volume sphere, used for rig visualization and collision.

HeadBaseTposeAdjustment: CFrame#

ReadSafe

Coordinate frame adjustment applied to the head base joint to align it with the T-pose reference orientation.

LeftAnkle: Instance#

ReadSafe

The Motor6D, AnimationConstraint, or Bone joint instance for the left ankle joint.

LeftAnkleRangeMax: Vector3#

ReadSafe

Maximum rotation range in degrees for the left ankle joint along each local axis (X, Y, Z).

LeftAnkleRangeMin: Vector3#

ReadSafe

Minimum rotation range in degrees for the left ankle joint along each local axis (X, Y, Z).

LeftAnkleSize: float#

ReadSafe

Diameter of the left ankle joint's volume sphere, used for rig visualization and collision.

LeftAnkleTposeAdjustment: CFrame#

ReadSafe

Coordinate frame adjustment applied to the left ankle joint to align it with the T-pose reference orientation.

LeftClavicle: Instance#

ReadSafe

The Motor6D, AnimationConstraint, or Bone joint instance for the left clavicle (collarbone) joint.

LeftClavicleRangeMax: Vector3#

ReadSafe

Maximum rotation range in degrees for the left clavicle joint along each local axis (X, Y, Z).

LeftClavicleRangeMin: Vector3#

ReadSafe

Minimum rotation range in degrees for the left clavicle joint along each local axis (X, Y, Z).

LeftClavicleSize: float#

ReadSafe

Diameter of the left clavicle joint's volume sphere, used for rig visualization and collision.

LeftClavicleTposeAdjustment: CFrame#

ReadSafe

Coordinate frame adjustment applied to the left clavicle joint to align it with the T-pose reference orientation.

LeftElbow: Instance#

ReadSafe

The Motor6D, AnimationConstraint, or Bone joint instance for the left elbow joint.

LeftElbowRangeMax: Vector3#

ReadSafe

Maximum rotation range in degrees for the left elbow joint along each local axis (X, Y, Z).

LeftElbowRangeMin: Vector3#

ReadSafe

Minimum rotation range in degrees for the left elbow joint along each local axis (X, Y, Z).

LeftElbowSize: float#

ReadSafe

Diameter of the left elbow joint's volume sphere, used for rig visualization and collision.

LeftElbowTposeAdjustment: CFrame#

ReadSafe

Coordinate frame adjustment applied to the left elbow joint to align it with the T-pose reference orientation.

LeftHip: Instance#

ReadSafe

The Motor6D, AnimationConstraint, or Bone joint instance for the left hip joint. This is the root of the left leg chain.

LeftHipRangeMax: Vector3#

ReadSafe

Maximum rotation range in degrees for the left hip joint along each local axis (X, Y, Z).

LeftHipRangeMin: Vector3#

ReadSafe

Minimum rotation range in degrees for the left hip joint along each local axis (X, Y, Z).

LeftHipSize: float#

ReadSafe

Diameter of the left hip joint's volume sphere, used for rig visualization and collision.

LeftHipTposeAdjustment: CFrame#

ReadSafe

Coordinate frame adjustment applied to the left hip joint to align it with the T-pose reference orientation.

LeftKnee: Instance#

ReadSafe

The Motor6D, AnimationConstraint, or Bone joint instance for the left knee joint.

LeftKneeRangeMax: Vector3#

ReadSafe

Maximum rotation range in degrees for the left knee joint along each local axis (X, Y, Z).

LeftKneeRangeMin: Vector3#

ReadSafe

Minimum rotation range in degrees for the left knee joint along each local axis (X, Y, Z).

LeftKneeSize: float#

ReadSafe

Diameter of the left knee joint's volume sphere, used for rig visualization and collision.

LeftKneeTposeAdjustment: CFrame#

ReadSafe

Coordinate frame adjustment applied to the left knee joint to align it with the T-pose reference orientation.

LeftShoulder: Instance#

ReadSafe

The Motor6D, AnimationConstraint, or Bone joint instance for the left shoulder joint.

LeftShoulderRangeMax: Vector3#

ReadSafe

Maximum rotation range in degrees for the left shoulder joint along each local axis (X, Y, Z).

LeftShoulderRangeMin: Vector3#

ReadSafe

Minimum rotation range in degrees for the left shoulder joint along each local axis (X, Y, Z).

LeftShoulderSize: float#

ReadSafe

Diameter of the left shoulder joint's volume sphere, used for rig visualization and collision.

LeftShoulderTposeAdjustment: CFrame#

ReadSafe

Coordinate frame adjustment applied to the left shoulder joint to align it with the T-pose reference orientation.

LeftToeBase: Instance#

ReadSafe

The Motor6D, AnimationConstraint, or Bone joint instance for the left toe base joint. This is the terminal joint of the left leg chain.

LeftToeBaseRangeMax: Vector3#

ReadSafe

Maximum rotation range in degrees for the left toe base joint along each local axis (X, Y, Z).

LeftToeBaseRangeMin: Vector3#

ReadSafe

Minimum rotation range in degrees for the left toe base joint along each local axis (X, Y, Z).

LeftToeBaseSize: float#

ReadSafe

Diameter of the left toe base joint's volume sphere, used for rig visualization and collision.

LeftToeBaseTposeAdjustment: CFrame#

ReadSafe

Coordinate frame adjustment applied to the left toe base joint to align it with the T-pose reference orientation.

LeftWrist: Instance#

ReadSafe

The Motor6D, AnimationConstraint, or Bone joint instance for the left wrist joint. This is the terminal joint of the left arm chain.

LeftWristRangeMax: Vector3#

ReadSafe

Maximum rotation range in degrees for the left wrist joint along each local axis (X, Y, Z).

LeftWristRangeMin: Vector3#

ReadSafe

Minimum rotation range in degrees for the left wrist joint along each local axis (X, Y, Z).

LeftWristSize: float#

ReadSafe

Diameter of the left wrist joint's volume sphere, used for rig visualization and collision.

LeftWristTposeAdjustment: CFrame#

ReadSafe

Coordinate frame adjustment applied to the left wrist joint to align it with the T-pose reference orientation.

Neck: Instance#

ReadSafe

The Motor6D, AnimationConstraint, or Bone joint instance for the neck joint.

NeckRangeMax: Vector3#

ReadSafe

Maximum rotation range in degrees for the neck joint along each local axis (X, Y, Z).

NeckRangeMin: Vector3#

ReadSafe

Minimum rotation range in degrees for the neck joint along each local axis (X, Y, Z).

NeckSize: float#

ReadSafe

Diameter of the neck joint's volume sphere, used for rig visualization and collision.

NeckTposeAdjustment: CFrame#

ReadSafe

Coordinate frame adjustment applied to the neck joint to align it with the T-pose reference orientation.

OriginOffset: CFrame#

ReadSafe

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.

RightAnkle: Instance#

ReadSafe

The Motor6D, AnimationConstraint, or Bone joint instance for the right ankle joint.

RightAnkleRangeMax: Vector3#

ReadSafe

Maximum rotation range in degrees for the right ankle joint along each local axis (X, Y, Z).

RightAnkleRangeMin: Vector3#

ReadSafe

Minimum rotation range in degrees for the right ankle joint along each local axis (X, Y, Z).

RightAnkleSize: float#

ReadSafe

Diameter of the right ankle joint's volume sphere, used for rig visualization and collision.

RightAnkleTposeAdjustment: CFrame#

ReadSafe

Coordinate frame adjustment applied to the right ankle joint to align it with the T-pose reference orientation.

RightClavicle: Instance#

ReadSafe

The Motor6D, AnimationConstraint, or Bone joint instance for the right clavicle (collarbone) joint.

RightClavicleRangeMax: Vector3#

ReadSafe

Maximum rotation range in degrees for the right clavicle joint along each local axis (X, Y, Z).

RightClavicleRangeMin: Vector3#

ReadSafe

Minimum rotation range in degrees for the right clavicle joint along each local axis (X, Y, Z).

RightClavicleSize: float#

ReadSafe

Diameter of the right clavicle joint's volume sphere, used for rig visualization and collision.

RightClavicleTposeAdjustment: CFrame#

ReadSafe

Coordinate frame adjustment applied to the right clavicle joint to align it with the T-pose reference orientation.

RightElbow: Instance#

ReadSafe

The Motor6D, AnimationConstraint, or Bone joint instance for the right elbow joint.

RightElbowRangeMax: Vector3#

ReadSafe

Maximum rotation range in degrees for the right elbow joint along each local axis (X, Y, Z).

RightElbowRangeMin: Vector3#

ReadSafe

Minimum rotation range in degrees for the right elbow joint along each local axis (X, Y, Z).

RightElbowSize: float#

ReadSafe

Diameter of the right elbow joint's volume sphere, used for rig visualization and collision.

RightElbowTposeAdjustment: CFrame#

ReadSafe

Coordinate frame adjustment applied to the right elbow joint to align it with the T-pose reference orientation.

RightHip: Instance#

ReadSafe

The Motor6D, AnimationConstraint, or Bone joint instance for the right hip joint. This is the root of the right leg chain.

RightHipRangeMax: Vector3#

ReadSafe

Maximum rotation range in degrees for the right hip joint along each local axis (X, Y, Z).

RightHipRangeMin: Vector3#

ReadSafe

Minimum rotation range in degrees for the right hip joint along each local axis (X, Y, Z).

RightHipSize: float#

ReadSafe

Diameter of the right hip joint's volume sphere, used for rig visualization and collision.

RightHipTposeAdjustment: CFrame#

ReadSafe

Coordinate frame adjustment applied to the right hip joint to align it with the T-pose reference orientation.

RightKnee: Instance#

ReadSafe

The Motor6D, AnimationConstraint, or Bone joint instance for the right knee joint.

RightKneeRangeMax: Vector3#

ReadSafe

Maximum rotation range in degrees for the right knee joint along each local axis (X, Y, Z).

RightKneeRangeMin: Vector3#

ReadSafe

Minimum rotation range in degrees for the right knee joint along each local axis (X, Y, Z).

RightKneeSize: float#

ReadSafe

Diameter of the right knee joint's volume sphere, used for rig visualization and collision.

RightKneeTposeAdjustment: CFrame#

ReadSafe

Coordinate frame adjustment applied to the right knee joint to align it with the T-pose reference orientation.

RightShoulder: Instance#

ReadSafe

The Motor6D, AnimationConstraint, or Bone joint instance for the right shoulder joint.

RightShoulderRangeMax: Vector3#

ReadSafe

Maximum rotation range in degrees for the right shoulder joint along each local axis (X, Y, Z).

RightShoulderRangeMin: Vector3#

ReadSafe

Minimum rotation range in degrees for the right shoulder joint along each local axis (X, Y, Z).

RightShoulderSize: float#

ReadSafe

Diameter of the right shoulder joint's volume sphere, used for rig visualization and collision.

RightShoulderTposeAdjustment: CFrame#

ReadSafe

Coordinate frame adjustment applied to the right shoulder joint to align it with the T-pose reference orientation.

RightToeBase: Instance#

ReadSafe

The Motor6D, AnimationConstraint, or Bone joint instance for the right toe base joint. This is the terminal joint of the right leg chain.

RightToeBaseRangeMax: Vector3#

ReadSafe

Maximum rotation range in degrees for the right toe base joint along each local axis (X, Y, Z).

RightToeBaseRangeMin: Vector3#

ReadSafe

Minimum rotation range in degrees for the right toe base joint along each local axis (X, Y, Z).

RightToeBaseSize: float#

ReadSafe

Diameter of the right toe base joint's volume sphere, used for rig visualization and collision.

RightToeBaseTposeAdjustment: CFrame#

ReadSafe

Coordinate frame adjustment applied to the right toe base joint to align it with the T-pose reference orientation.

RightWrist: Instance#

ReadSafe

The Motor6D, AnimationConstraint, or Bone joint instance for the right wrist joint. This is the terminal joint of the right arm chain.

RightWristRangeMax: Vector3#

ReadSafe

Maximum rotation range in degrees for the right wrist joint along each local axis (X, Y, Z).

RightWristRangeMin: Vector3#

ReadSafe

Minimum rotation range in degrees for the right wrist joint along each local axis (X, Y, Z).

RightWristSize: float#

ReadSafe

Diameter of the right wrist joint's volume sphere, used for rig visualization and collision.

RightWristTposeAdjustment: CFrame#

ReadSafe

Coordinate frame adjustment applied to the right wrist joint to align it with the T-pose reference orientation.

Root: Instance#

ReadSafe

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.

RootRangeMax: Vector3#

ReadSafe

Maximum rotation range in degrees for the root joint along each local axis (X, Y, Z).

RootRangeMin: Vector3#

ReadSafe

Minimum rotation range in degrees for the root joint along each local axis (X, Y, Z).

RootSize: float#

ReadSafe

Diameter of the root joint's volume sphere, used for rig visualization and collision.

RootTposeAdjustment: CFrame#

ReadSafe

Coordinate frame adjustment applied to the root joint to align it with the T-pose reference orientation.

Spine: Instance#

ReadSafe

The Motor6D, AnimationConstraint, or Bone joint instance for the spine joint.

SpineRangeMax: Vector3#

ReadSafe

Maximum rotation range in degrees for the spine joint along each local axis (X, Y, Z).

SpineRangeMin: Vector3#

ReadSafe

Minimum rotation range in degrees for the spine joint along each local axis (X, Y, Z).

SpineSize: float#

ReadSafe

Diameter of the spine joint's volume sphere, used for rig visualization and collision.

SpineTposeAdjustment: CFrame#

ReadSafe

Coordinate frame adjustment applied to the spine joint to align it with the T-pose reference orientation.

Waist: Instance#

ReadSafe

The Motor6D, AnimationConstraint, or Bone joint instance for the waist joint.

WaistRangeMax: Vector3#

ReadSafe

Maximum rotation range in degrees for the waist joint along each local axis (X, Y, Z).

WaistRangeMin: Vector3#

ReadSafe

Minimum rotation range in degrees for the waist joint along each local axis (X, Y, Z).

WaistSize: float#

ReadSafe

Diameter of the waist joint's volume sphere, used for rig visualization and collision.

WaistTposeAdjustment: CFrame#

ReadSafe

Coordinate frame adjustment applied to the waist joint to align it with the T-pose reference orientation.

Methods 4#

GetJointFromNameReturns the joint instance associated with the given name string.Safe
GetJointNamesReturns the full set of 22 standard joint names in hierarchy order.Safe
GetR15JointNamesReturns the 15 joint names used by R15 rigs.Safe
GetR6JointNamesReturns the 6 joint names used by R6 rigs.Safe

GetJointFromName(name: string): Instance#

Safe

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.

NameTypeDefaultDescription
namestringstring
Returns

GetJointNames(): Array#

Safe

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
  • Array — Array

GetR15JointNames(): Array#

Safe

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
  • Array — Array

GetR6JointNames(): Array#

Safe

Returns an array of the 6 joint name strings used by R6 rigs: Root, Neck, LeftShoulder, RightShoulder, LeftHip, RightHip.

Returns
  • Array — Array

Inherited members#

Inherited from Instance 58
Inherited from Object 6
Properties (2)

ClassName, className

Events (1)

Changed