DigitsRigDescription
Maps the 15 phalanx joints of one hand (5 fingers, 3 joints each) and exposes forward- and inverse-kinematics helpers for controlling finger poses at runtime.
| Memory category | Animation |
|---|
Member index 50
Description
Enables interoperability of animations across hand rigs and drives the hand
finger solver. Each DigitsRigDescription maps the 15 phalanx joints of one
hand (5 fingers with 3 joints each) to engine instances, stores their T-pose
adjustments, and exposes forward- and inverse-kinematics helpers for
controlling finger poses at runtime.
History 92
- 726 Change Default of ThumbSize from 0 to
- 726 Change Default of ThumbRange from Vector3(0, 0, 0) to
- 726 Change Default of Thumb3TposeAdjustment from CFrame(0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0, 1) to
- 726 Change Default of Thumb3 from to
- 726 Change Default of Thumb2TposeAdjustment from CFrame(0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0, 1) to
- 726 Change Default of Thumb2 from to
- 726 Change Default of Thumb1TposeAdjustment from CFrame(0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0, 1) to
- 726 Change Default of Thumb1 from to
- 726 Change Default of Side from None to
- 726 Change Default of RingSize from 0 to
- 726 Change Default of RingRange from Vector3(0, 0, 0) to
- 726 Change Default of Ring3TposeAdjustment from CFrame(0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0, 1) to
- 726 Change Default of Ring3 from to
- 726 Change Default of Ring2TposeAdjustment from CFrame(0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0, 1) to
- 726 Change Default of Ring2 from to
- 726 Change Default of Ring1TposeAdjustment from CFrame(0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0, 1) to
- 726 Change Default of Ring1 from to
- 726 Change Default of PinkySize from 0 to
- 726 Change Default of PinkyRange from Vector3(0, 0, 0) to
- 726 Change Default of Pinky3TposeAdjustment from CFrame(0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0, 1) to
- 726 Change Default of Pinky3 from to
- 726 Change Default of Pinky2TposeAdjustment from CFrame(0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0, 1) to
- 726 Change Default of Pinky2 from to
- 726 Change Default of Pinky1TposeAdjustment from CFrame(0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0, 1) to
- 726 Change Default of Pinky1 from to
- 726 Change Default of MiddleSize from 0 to
- 726 Change Default of MiddleRange from Vector3(0, 0, 0) to
- 726 Change Default of Middle3TposeAdjustment from CFrame(0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0, 1) to
- 726 Change Default of Middle3 from to
- 726 Change Default of Middle2TposeAdjustment from CFrame(0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0, 1) to
- 726 Change Default of Middle2 from to
- 726 Change Default of Middle1TposeAdjustment from CFrame(0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0, 1) to
- 726 Change Default of Middle1 from to
- 726 Change Default of IndexSize from 0 to
- 726 Change Default of IndexRange from Vector3(0, 0, 0) to
- 726 Change Default of Index3TposeAdjustment from CFrame(0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0, 1) to
- 726 Change Default of Index3 from to
- 726 Change Default of Index2TposeAdjustment from CFrame(0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0, 1) to
- 726 Change Default of Index2 from to
- 726 Change Default of Index1TposeAdjustment from CFrame(0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0, 1) to
- 726 Change Default of Index1 from to
- 711 Add SetTposeAdjustment
- 711 Add SetJoint
- 711 Add SetFingerTip
- 711 Add SetFingerControl
- 711 Add GetTposeAdjustment
- 711 Add GetJointLabels
- 711 Add GetJoint
- 711 Add GetFingerTip
- 711 Add GetFingerControl
- 711 Add ThumbSize
- 711 Add ThumbRange
- 711 Add Thumb3TposeAdjustment
- 711 Add Thumb3
- 711 Add Thumb2TposeAdjustment
- 711 Add Thumb2
- 711 Add Thumb1TposeAdjustment
- 711 Add Thumb1
- 711 Add Side
- 711 Add RingSize
- 711 Add RingRange
- 711 Add Ring3TposeAdjustment
- 711 Add Ring3
- 711 Add Ring2TposeAdjustment
- 711 Add Ring2
- 711 Add Ring1TposeAdjustment
- 711 Add Ring1
- 711 Add PinkySize
- 711 Add PinkyRange
- 711 Add Pinky3TposeAdjustment
- 711 Add Pinky3
- 711 Add Pinky2TposeAdjustment
- 711 Add Pinky2
- 711 Add Pinky1TposeAdjustment
- 711 Add Pinky1
- 711 Add MiddleSize
- 711 Add MiddleRange
- 711 Add Middle3TposeAdjustment
- 711 Add Middle3
- 711 Add Middle2TposeAdjustment
- 711 Add Middle2
- 711 Add Middle1TposeAdjustment
- 711 Add Middle1
- 711 Add IndexSize
- 711 Add IndexRange
- 711 Add Index3TposeAdjustment
- 711 Add Index3
- 711 Add Index2TposeAdjustment
- 711 Add Index2
- 711 Add Index1TposeAdjustment
- 711 Add Index1
- 711 Add DigitsRigDescription
Members 50
GetFingerControl
| Parameters (1) | ||
|---|---|---|
| fingerIndex | int | |
| Returns (1) | ||
| Vector3 | ||
Returns the current control Vector3 for the finger at the given 1-based
index (1 = Thumb … 5 = Pinky). The components are:
- X — extension in
[0, 1]:0is fully curled,1is fully extended. - Y — lateral (side) rotation in
[-1, 1]. - Z — axial (twist) rotation in
[-1, 1].
| Thread safety | Unsafe |
|---|
History 1
- 711 Add GetFingerControl
GetFingerTip
| Parameters (1) | ||
|---|---|---|
| fingerIndex | int | |
| Returns (1) | ||
| Vector3 | ||
Returns the world-space position of the fingertip for the finger at the
given 1-based index (1 = Thumb … 5 = Pinky). Not yet implemented;
currently returns Vector3.zero.
| Thread safety | Unsafe |
|---|
History 1
- 711 Add GetFingerTip
GetJoint
| Parameters (1) | ||
|---|---|---|
| label | RigLabel | |
| Returns (1) | ||
| Instance | ||
| Security | RobloxScriptSecurity |
|---|---|
| Thread safety | Safe |
GetJointLabels
| Parameters (0) | ||
|---|---|---|
| No parameters. | ||
| Returns (1) | ||
| Array | ||
| Security | RobloxScriptSecurity |
|---|---|
| Thread safety | Safe |
History 1
- 711 Add GetJointLabels
GetTposeAdjustment
| Parameters (1) | ||
|---|---|---|
| label | RigLabel | |
| Returns (1) | ||
| CFrame | ||
| Security | RobloxScriptSecurity |
|---|---|
| Thread safety | Safe |
History 1
Index1
| Type | Default | |
|---|---|---|
| Instance | ||
The Motor6D, AnimationConstraint, or Bone instance mapped to the proximal (first) phalanx of the index finger.
| Thread safety | ReadSafe |
|---|---|
| Category | Mapping |
| Loaded/Saved | true |
Index1TposeAdjustment
| Type | Default | |
|---|---|---|
| CFrame | ||
CoordinateFrame applied to Index1 to normalize the joint into its
canonical T-pose orientation before retargeting or solving.
| Thread safety | ReadSafe |
|---|---|
| Category | Tpose |
| Loaded/Saved | true |
History 2
- 726 Change Default of Index1TposeAdjustment from CFrame(0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0, 1) to
- 711 Add Index1TposeAdjustment
Index2
| Type | Default | |
|---|---|---|
| Instance | ||
The Instance mapped to the medial (second) phalanx of the index finger.
| Thread safety | ReadSafe |
|---|---|
| Category | Mapping |
| Loaded/Saved | true |
Index2TposeAdjustment
| Type | Default | |
|---|---|---|
| CFrame | ||
CoordinateFrame applied to Index2 to normalize the joint into its
canonical T-pose orientation before retargeting or solving.
| Thread safety | ReadSafe |
|---|---|
| Category | Tpose |
| Loaded/Saved | true |
History 2
- 726 Change Default of Index2TposeAdjustment from CFrame(0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0, 1) to
- 711 Add Index2TposeAdjustment
Index3
| Type | Default | |
|---|---|---|
| Instance | ||
The Instance mapped to the distal (third) phalanx of the index finger.
| Thread safety | ReadSafe |
|---|---|
| Category | Mapping |
| Loaded/Saved | true |
Index3TposeAdjustment
| Type | Default | |
|---|---|---|
| CFrame | ||
CoordinateFrame applied to Index3 to normalize the joint into its
canonical T-pose orientation before retargeting or solving.
| Thread safety | ReadSafe |
|---|---|
| Category | Tpose |
| Loaded/Saved | true |
History 2
- 726 Change Default of Index3TposeAdjustment from CFrame(0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0, 1) to
- 711 Add Index3TposeAdjustment
IndexRange
| Type | Default | |
|---|---|---|
| Vector3 | ||
A Vector3 describing the motion range of the index finger, used by the
finger solver.
| Thread safety | ReadSafe |
|---|---|
| Category | Range |
| Loaded/Saved | true |
History 2
- 726 Change Default of IndexRange from Vector3(0, 0, 0) to
- 711 Add IndexRange
IndexSize
| Type | Default | |
|---|---|---|
| float | ||
Size of the index finger, used by the finger solver to preserve contacts.
| Thread safety | ReadSafe |
|---|---|
| Category | Size |
| Loaded/Saved | true |
Middle1
| Type | Default | |
|---|---|---|
| Instance | ||
The Instance mapped to the proximal (first) phalanx of the middle
finger.
| Thread safety | ReadSafe |
|---|---|
| Category | Mapping |
| Loaded/Saved | true |
Middle1TposeAdjustment
| Type | Default | |
|---|---|---|
| CFrame | ||
CoordinateFrame applied to Middle1 to normalize the joint into its
canonical T-pose orientation before retargeting or solving.
| Thread safety | ReadSafe |
|---|---|
| Category | Tpose |
| Loaded/Saved | true |
History 2
- 726 Change Default of Middle1TposeAdjustment from CFrame(0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0, 1) to
- 711 Add Middle1TposeAdjustment
Middle2
| Type | Default | |
|---|---|---|
| Instance | ||
The Instance mapped to the medial (second) phalanx of the middle finger.
| Thread safety | ReadSafe |
|---|---|
| Category | Mapping |
| Loaded/Saved | true |
Middle2TposeAdjustment
| Type | Default | |
|---|---|---|
| CFrame | ||
CoordinateFrame applied to Middle2 to normalize the joint into its
canonical T-pose orientation before retargeting or solving.
| Thread safety | ReadSafe |
|---|---|
| Category | Tpose |
| Loaded/Saved | true |
History 2
- 726 Change Default of Middle2TposeAdjustment from CFrame(0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0, 1) to
- 711 Add Middle2TposeAdjustment
Middle3
| Type | Default | |
|---|---|---|
| Instance | ||
The Instance mapped to the distal (third) phalanx of the middle finger.
| Thread safety | ReadSafe |
|---|---|
| Category | Mapping |
| Loaded/Saved | true |
Middle3TposeAdjustment
| Type | Default | |
|---|---|---|
| CFrame | ||
CoordinateFrame applied to Middle3 to normalize the joint into its
canonical T-pose orientation before retargeting or solving.
| Thread safety | ReadSafe |
|---|---|
| Category | Tpose |
| Loaded/Saved | true |
History 2
- 726 Change Default of Middle3TposeAdjustment from CFrame(0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0, 1) to
- 711 Add Middle3TposeAdjustment
MiddleRange
| Type | Default | |
|---|---|---|
| Vector3 | ||
A Vector3 describing the motion range of the middle finger, used by the
finger solver and scalable-property system.
| Thread safety | ReadSafe |
|---|---|
| Category | Range |
| Loaded/Saved | true |
History 2
- 726 Change Default of MiddleRange from Vector3(0, 0, 0) to
- 711 Add MiddleRange
MiddleSize
| Type | Default | |
|---|---|---|
| float | ||
Scale factor for the middle finger, used when the rig is scaled through the scalable-property system.
| Thread safety | ReadSafe |
|---|---|
| Category | Size |
| Loaded/Saved | true |
History 2
- 726 Change Default of MiddleSize from 0 to
- 711 Add MiddleSize
Pinky1
| Type | Default | |
|---|---|---|
| Instance | ||
The Instance mapped to the proximal (first) phalanx of the pinky finger.
| Thread safety | ReadSafe |
|---|---|
| Category | Mapping |
| Loaded/Saved | true |
Pinky1TposeAdjustment
| Type | Default | |
|---|---|---|
| CFrame | ||
CoordinateFrame applied to Pinky1 to normalize the joint into its
canonical T-pose orientation before retargeting or solving.
| Thread safety | ReadSafe |
|---|---|
| Category | Tpose |
| Loaded/Saved | true |
History 2
- 726 Change Default of Pinky1TposeAdjustment from CFrame(0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0, 1) to
- 711 Add Pinky1TposeAdjustment
Pinky2
| Type | Default | |
|---|---|---|
| Instance | ||
The Instance mapped to the medial (second) phalanx of the pinky finger.
| Thread safety | ReadSafe |
|---|---|
| Category | Mapping |
| Loaded/Saved | true |
Pinky2TposeAdjustment
| Type | Default | |
|---|---|---|
| CFrame | ||
CoordinateFrame applied to Pinky2 to normalize the joint into its
canonical T-pose orientation before retargeting or solving.
| Thread safety | ReadSafe |
|---|---|
| Category | Tpose |
| Loaded/Saved | true |
History 2
- 726 Change Default of Pinky2TposeAdjustment from CFrame(0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0, 1) to
- 711 Add Pinky2TposeAdjustment
Pinky3
| Type | Default | |
|---|---|---|
| Instance | ||
The Instance mapped to the distal (third) phalanx of the pinky finger.
| Thread safety | ReadSafe |
|---|---|
| Category | Mapping |
| Loaded/Saved | true |
Pinky3TposeAdjustment
| Type | Default | |
|---|---|---|
| CFrame | ||
CoordinateFrame applied to Pinky3 to normalize the joint into its
canonical T-pose orientation before retargeting or solving.
| Thread safety | ReadSafe |
|---|---|
| Category | Tpose |
| Loaded/Saved | true |
History 2
- 726 Change Default of Pinky3TposeAdjustment from CFrame(0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0, 1) to
- 711 Add Pinky3TposeAdjustment
PinkyRange
| Type | Default | |
|---|---|---|
| Vector3 | ||
A Vector3 describing the motion range of the pinky finger, used by the
finger solver and scalable-property system.
| Thread safety | ReadSafe |
|---|---|
| Category | Range |
| Loaded/Saved | true |
History 2
- 726 Change Default of PinkyRange from Vector3(0, 0, 0) to
- 711 Add PinkyRange
PinkySize
| Type | Default | |
|---|---|---|
| float | ||
Scale factor for the pinky finger, used when the rig is scaled through the scalable-property system.
| Thread safety | ReadSafe |
|---|---|
| Category | Size |
| Loaded/Saved | true |
Ring1
| Type | Default | |
|---|---|---|
| Instance | ||
The Instance mapped to the proximal (first) phalanx of the ring finger.
| Thread safety | ReadSafe |
|---|---|
| Category | Mapping |
| Loaded/Saved | true |
Ring1TposeAdjustment
| Type | Default | |
|---|---|---|
| CFrame | ||
CoordinateFrame applied to Ring1 to normalize the joint into its
canonical T-pose orientation before retargeting or solving.
| Thread safety | ReadSafe |
|---|---|
| Category | Tpose |
| Loaded/Saved | true |
History 2
- 726 Change Default of Ring1TposeAdjustment from CFrame(0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0, 1) to
- 711 Add Ring1TposeAdjustment
Ring2
| Type | Default | |
|---|---|---|
| Instance | ||
The Instance mapped to the medial (second) phalanx of the ring finger.
| Thread safety | ReadSafe |
|---|---|
| Category | Mapping |
| Loaded/Saved | true |
Ring2TposeAdjustment
| Type | Default | |
|---|---|---|
| CFrame | ||
CoordinateFrame applied to Ring2 to normalize the joint into its
canonical T-pose orientation before retargeting or solving.
| Thread safety | ReadSafe |
|---|---|
| Category | Tpose |
| Loaded/Saved | true |
History 2
- 726 Change Default of Ring2TposeAdjustment from CFrame(0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0, 1) to
- 711 Add Ring2TposeAdjustment
Ring3
| Type | Default | |
|---|---|---|
| Instance | ||
The Instance mapped to the distal (third) phalanx of the ring finger.
| Thread safety | ReadSafe |
|---|---|
| Category | Mapping |
| Loaded/Saved | true |
Ring3TposeAdjustment
| Type | Default | |
|---|---|---|
| CFrame | ||
CoordinateFrame applied to Ring3 to normalize the joint into its
canonical T-pose orientation before retargeting or solving.
| Thread safety | ReadSafe |
|---|---|
| Category | Tpose |
| Loaded/Saved | true |
History 2
- 726 Change Default of Ring3TposeAdjustment from CFrame(0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0, 1) to
- 711 Add Ring3TposeAdjustment
RingRange
| Type | Default | |
|---|---|---|
| Vector3 | ||
A Vector3 describing the motion range of the ring finger, used by the
finger solver and scalable-property system.
| Thread safety | ReadSafe |
|---|---|
| Category | Range |
| Loaded/Saved | true |
RingSize
| Type | Default | |
|---|---|---|
| float | ||
Scale factor for the ring finger, used when the rig is scaled through the scalable-property system.
| Thread safety | ReadSafe |
|---|---|
| Category | Size |
| Loaded/Saved | true |
SetFingerControl
| Parameters (2) | ||
|---|---|---|
| fingerIndex | int | |
| control | Vector3 | |
| Returns (1) | ||
| null | ||
Drives the three-joint chain of the finger at the given 1-based index (1 =
Thumb … 5 = Pinky) using forward kinematics. The control components are
clamped before application:
- X — extension, clamped to
[0, 1]. - Y — lateral rotation, clamped to
[-1, 1](maps to ±50°). - Z — axial rotation, clamped to
[-1, 1](maps to ±50°).
Joint angles for the three phalanges are computed via Ptolemy's theorem applied to the chain lengths.
| Thread safety | Unsafe |
|---|
History 1
- 711 Add SetFingerControl
SetFingerTip
| Parameters (2) | ||
|---|---|---|
| fingerIndex | int | |
| point | Vector3 | |
| Returns (1) | ||
| null | ||
Moves the fingertip of the finger at the given 1-based index (1 = Thumb …
5 = Pinky) toward the world-space target point using inverse kinematics.
The solver computes the required extension, lateral, and axial control
values and then calls SetFingerControl internally.
| Thread safety | Unsafe |
|---|
History 1
- 711 Add SetFingerTip
SetJoint
| Parameters (2) | ||
|---|---|---|
| label | RigLabel | |
| joint | Instance | |
| Returns (1) | ||
| null | ||
| Security | RobloxScriptSecurity |
|---|---|
| Thread safety | Safe |
SetTposeAdjustment
| Parameters (2) | ||
|---|---|---|
| label | RigLabel | |
| transform | CFrame | |
| Returns (1) | ||
| null | ||
| Security | RobloxScriptSecurity |
|---|---|
| Thread safety | Safe |
History 1
Side
| Type | Default | |
|---|---|---|
| DigitsRigDescriptionSide | ||
Which hand this description belongs to: None, Left, or Right. Used
when mapping HandRigLabel joints to the corresponding HumanoidRigLabel
entries on the parent HumanoidRigDescription.
| Thread safety | ReadSafe |
|---|---|
| Category | Data |
| Loaded/Saved | true |
Thumb1
| Type | Default | |
|---|---|---|
| Instance | ||
The Instance mapped to the proximal (first) phalanx of the thumb.
| Thread safety | ReadSafe |
|---|---|
| Category | Mapping |
| Loaded/Saved | true |
Thumb1TposeAdjustment
| Type | Default | |
|---|---|---|
| CFrame | ||
CoordinateFrame applied to Thumb1 to normalize the joint into its
canonical T-pose orientation before retargeting or solving.
| Thread safety | ReadSafe |
|---|---|
| Category | Tpose |
| Loaded/Saved | true |
History 2
- 726 Change Default of Thumb1TposeAdjustment from CFrame(0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0, 1) to
- 711 Add Thumb1TposeAdjustment
Thumb2
| Type | Default | |
|---|---|---|
| Instance | ||
The Instance mapped to the medial (second) phalanx of the thumb.
| Thread safety | ReadSafe |
|---|---|
| Category | Mapping |
| Loaded/Saved | true |
Thumb2TposeAdjustment
| Type | Default | |
|---|---|---|
| CFrame | ||
CoordinateFrame applied to Thumb2 to normalize the joint into its
canonical T-pose orientation before retargeting or solving.
| Thread safety | ReadSafe |
|---|---|
| Category | Tpose |
| Loaded/Saved | true |
History 2
- 726 Change Default of Thumb2TposeAdjustment from CFrame(0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0, 1) to
- 711 Add Thumb2TposeAdjustment
Thumb3
| Type | Default | |
|---|---|---|
| Instance | ||
The Instance mapped to the distal (third) phalanx of the thumb.
| Thread safety | ReadSafe |
|---|---|
| Category | Mapping |
| Loaded/Saved | true |
Thumb3TposeAdjustment
| Type | Default | |
|---|---|---|
| CFrame | ||
CoordinateFrame applied to Thumb3 to normalize the joint into its
canonical T-pose orientation before retargeting or solving.
| Thread safety | ReadSafe |
|---|---|
| Category | Tpose |
| Loaded/Saved | true |
History 2
- 726 Change Default of Thumb3TposeAdjustment from CFrame(0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0, 1) to
- 711 Add Thumb3TposeAdjustment
ThumbRange
| Type | Default | |
|---|---|---|
| Vector3 | ||
A Vector3 describing the motion range of the thumb, used by the finger
solver and scalable-property system.
| Thread safety | ReadSafe |
|---|---|
| Category | Range |
| Loaded/Saved | true |
History 2
- 726 Change Default of ThumbRange from Vector3(0, 0, 0) to
- 711 Add ThumbRange
ThumbSize
| Type | Default | |
|---|---|---|
| float | ||
Scale factor for the thumb, used when the rig is scaled through the scalable-property system.
| Thread safety | ReadSafe |
|---|---|
| Category | Size |
| Loaded/Saved | true |