Reference API Roblox

Engine API

Website

Related

Reference API Roblox

DigitsRigDescription

Member index 50

HistoryMember
711Index1: Instance
711Index1TposeAdjustment: CFrame
711Index2: Instance
711Index2TposeAdjustment: CFrame
711Index3: Instance
711Index3TposeAdjustment: CFrame
711IndexRange: Vector3
711IndexSize: float
711Middle1: Instance
711Middle1TposeAdjustment: CFrame
711Middle2: Instance
711Middle2TposeAdjustment: CFrame
711Middle3: Instance
711Middle3TposeAdjustment: CFrame
711MiddleRange: Vector3
711MiddleSize: float
711Pinky1: Instance
711Pinky1TposeAdjustment: CFrame
711Pinky2: Instance
711Pinky2TposeAdjustment: CFrame
711Pinky3: Instance
711Pinky3TposeAdjustment: CFrame
711PinkyRange: Vector3
711PinkySize: float
711Ring1: Instance
711Ring1TposeAdjustment: CFrame
711Ring2: Instance
711Ring2TposeAdjustment: CFrame
711Ring3: Instance
711Ring3TposeAdjustment: CFrame
711RingRange: Vector3
711RingSize: float
711Side: DigitsRigDescriptionSide
711Thumb1: Instance
711Thumb1TposeAdjustment: CFrame
711Thumb2: Instance
711Thumb2TposeAdjustment: CFrame
711Thumb3: Instance
711Thumb3TposeAdjustment: CFrame
711ThumbRange: Vector3
711ThumbSize: float
711GetFingerControl(fingerIndex: int): Vector3
711GetFingerTip(fingerIndex: int): Vector3
711GetJoint(label: RigLabel): Instance
711GetJointLabels(): Array
711GetTposeAdjustment(label: RigLabel): CFrame
711SetFingerControl(fingerIndex: int, control: Vector3): null
711SetFingerTip(fingerIndex: int, point: Vector3): null
711SetJoint(label: RigLabel, joint: Instance): null
711SetTposeAdjustment(label: RigLabel, transform: CFrame): null
inherited from Instance
553Archivable: bool
670Capabilities: SecurityCapabilities
553Name: string
553Parent: Instance
702PredictionMode: PredictionMode
670Sandboxed: bool
680UniqueId: UniqueId
576AddTag(tag: string): null
573ClearAllChildren(): null
462Clone(): Instance
573Destroy(): null
486FindFirstAncestor(name: string): Instance
486FindFirstAncestorOfClass(className: string): Instance
486FindFirstAncestorWhichIsA(className: string): Instance
486FindFirstChild(name: string, recursive: bool = false): Instance
486FindFirstChildOfClass(className: string): Instance
486FindFirstChildWhichIsA(className: string, recursive: bool = false): Instance
486FindFirstDescendant(name: string): Instance
563GetActor(): Actor
486GetAttribute(attribute: string): Variant
462GetAttributeChangedSignal(attribute: string): RBXScriptSignal
631GetAttributes(): Dictionary
648GetChildren(): Instances
462GetDebugId(scopeLength: int = 4): string
707GetDescendants(): Instances
486GetFullName(): string
706GetStyled(name: string, selector: string?): Variant
657GetStyledPropertyChangedSignal(property: string): RBXScriptSignal
576GetTags(): Array
576HasTag(tag: string): bool
486IsAncestorOf(descendant: Instance): bool
486IsDescendantOf(ancestor: Instance): bool
664IsPropertyModified(property: string): bool
698QueryDescendants(selector: string): Instances
573Remove(): null
576RemoveTag(tag: string): null
664ResetPropertyToDefault(property: string): null
573SetAttribute(attribute: string, value: Variant): null
462WaitForChild(childName: string, timeOut: double): Instance
648children(): Instances
553clone(): Instance
573destroy(): null
553findFirstChild(name: string, recursive: bool = false): Instance
648getChildren(): Instances
553isDescendantOf(ancestor: Instance): bool
573remove(): null
462AncestryChanged(child: Instance, parent: Instance)
462AttributeChanged(attribute: string)
462ChildAdded(child: Instance)
462ChildRemoved(child: Instance)
462DescendantAdded(descendant: Instance)
462DescendantRemoving(descendant: Instance)
500Destroying()
657StyledPropertiesChanged()
553childAdded(child: Instance)
inherited from Object
647ClassName: string
647className: string
647GetPropertyChangedSignal(property: string): RBXScriptSignal
647IsA(className: string): bool
650isA(className: string): bool
647Changed(property: string)

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 51

Members 50

GetFingerControl

Parameters (1)
fingerIndexint
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]: 0 is fully curled, 1 is fully extended.
  • Y — lateral (side) rotation in [-1, 1].
  • Z — axial (twist) rotation in [-1, 1].

History 1

GetFingerTip

Parameters (1)
fingerIndexint
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.

History 1

GetJoint

Parameters (1)
labelRigLabel
Returns (1)
Instance

History 1

GetJointLabels

Parameters (0)
No parameters.
Returns (1)
Array

History 1

GetTposeAdjustment

Parameters (1)
labelRigLabel
Returns (1)
CFrame

History 1

Index1

TypeDefault
Instance

The Motor6D, AnimationConstraint, or Bone instance mapped to the proximal (first) phalanx of the index finger.

History 1

Index1TposeAdjustment

TypeDefault
CFrame0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0, 1

CoordinateFrame applied to Index1 to normalize the joint into its canonical T-pose orientation before retargeting or solving.

History 1

Index2

TypeDefault
Instance

The Instance mapped to the medial (second) phalanx of the index finger.

History 1

Index2TposeAdjustment

TypeDefault
CFrame0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0, 1

CoordinateFrame applied to Index2 to normalize the joint into its canonical T-pose orientation before retargeting or solving.

History 1

Index3

TypeDefault
Instance

The Instance mapped to the distal (third) phalanx of the index finger.

History 1

Index3TposeAdjustment

TypeDefault
CFrame0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0, 1

CoordinateFrame applied to Index3 to normalize the joint into its canonical T-pose orientation before retargeting or solving.

History 1

IndexRange

TypeDefault
Vector30, 0, 0

A Vector3 describing the motion range of the index finger, used by the finger solver.

History 1

IndexSize

TypeDefault
float0

Size of the index finger, used by the finger solver to preserve contacts.

History 1

Middle1

TypeDefault
Instance

The Instance mapped to the proximal (first) phalanx of the middle finger.

History 1

Middle1TposeAdjustment

TypeDefault
CFrame0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0, 1

CoordinateFrame applied to Middle1 to normalize the joint into its canonical T-pose orientation before retargeting or solving.

History 1

Middle2

TypeDefault
Instance

The Instance mapped to the medial (second) phalanx of the middle finger.

History 1

Middle2TposeAdjustment

TypeDefault
CFrame0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0, 1

CoordinateFrame applied to Middle2 to normalize the joint into its canonical T-pose orientation before retargeting or solving.

History 1

Middle3

TypeDefault
Instance

The Instance mapped to the distal (third) phalanx of the middle finger.

History 1

Middle3TposeAdjustment

TypeDefault
CFrame0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0, 1

CoordinateFrame applied to Middle3 to normalize the joint into its canonical T-pose orientation before retargeting or solving.

History 1

MiddleRange

TypeDefault
Vector30, 0, 0

A Vector3 describing the motion range of the middle finger, used by the finger solver and scalable-property system.

History 1

MiddleSize

TypeDefault
float0

Scale factor for the middle finger, used when the rig is scaled through the scalable-property system.

History 1

Pinky1

TypeDefault
Instance

The Instance mapped to the proximal (first) phalanx of the pinky finger.

History 1

Pinky1TposeAdjustment

TypeDefault
CFrame0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0, 1

CoordinateFrame applied to Pinky1 to normalize the joint into its canonical T-pose orientation before retargeting or solving.

History 1

Pinky2

TypeDefault
Instance

The Instance mapped to the medial (second) phalanx of the pinky finger.

History 1

Pinky2TposeAdjustment

TypeDefault
CFrame0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0, 1

CoordinateFrame applied to Pinky2 to normalize the joint into its canonical T-pose orientation before retargeting or solving.

History 1

Pinky3

TypeDefault
Instance

The Instance mapped to the distal (third) phalanx of the pinky finger.

History 1

Pinky3TposeAdjustment

TypeDefault
CFrame0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0, 1

CoordinateFrame applied to Pinky3 to normalize the joint into its canonical T-pose orientation before retargeting or solving.

History 1

PinkyRange

TypeDefault
Vector30, 0, 0

A Vector3 describing the motion range of the pinky finger, used by the finger solver and scalable-property system.

History 1

PinkySize

TypeDefault
float0

Scale factor for the pinky finger, used when the rig is scaled through the scalable-property system.

History 1

Ring1

TypeDefault
Instance

The Instance mapped to the proximal (first) phalanx of the ring finger.

History 1

Ring1TposeAdjustment

TypeDefault
CFrame0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0, 1

CoordinateFrame applied to Ring1 to normalize the joint into its canonical T-pose orientation before retargeting or solving.

History 1

Ring2

TypeDefault
Instance

The Instance mapped to the medial (second) phalanx of the ring finger.

History 1

Ring2TposeAdjustment

TypeDefault
CFrame0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0, 1

CoordinateFrame applied to Ring2 to normalize the joint into its canonical T-pose orientation before retargeting or solving.

History 1

Ring3

TypeDefault
Instance

The Instance mapped to the distal (third) phalanx of the ring finger.

History 1

Ring3TposeAdjustment

TypeDefault
CFrame0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0, 1

CoordinateFrame applied to Ring3 to normalize the joint into its canonical T-pose orientation before retargeting or solving.

History 1

RingRange

TypeDefault
Vector30, 0, 0

A Vector3 describing the motion range of the ring finger, used by the finger solver and scalable-property system.

History 1

RingSize

TypeDefault
float0

Scale factor for the ring finger, used when the rig is scaled through the scalable-property system.

History 1

SetFingerControl

Parameters (2)
fingerIndexint
controlVector3
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.

History 1

SetFingerTip

Parameters (2)
fingerIndexint
pointVector3
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.

History 1

SetJoint

Parameters (2)
labelRigLabel
jointInstance
Returns (1)
null

History 1

SetTposeAdjustment

Parameters (2)
labelRigLabel
transformCFrame
Returns (1)
null

History 1

Side

TypeDefault
DigitsRigDescriptionSideNone

Which hand this description belongs to: None, Left, or Right. Used when mapping HandRigLabel joints to the corresponding HumanoidRigLabel entries on the parent HumanoidRigDescription.

History 1

Thumb1

TypeDefault
Instance

The Instance mapped to the proximal (first) phalanx of the thumb.

History 1

Thumb1TposeAdjustment

TypeDefault
CFrame0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0, 1

CoordinateFrame applied to Thumb1 to normalize the joint into its canonical T-pose orientation before retargeting or solving.

History 1

Thumb2

TypeDefault
Instance

The Instance mapped to the medial (second) phalanx of the thumb.

History 1

Thumb2TposeAdjustment

TypeDefault
CFrame0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0, 1

CoordinateFrame applied to Thumb2 to normalize the joint into its canonical T-pose orientation before retargeting or solving.

History 1

Thumb3

TypeDefault
Instance

The Instance mapped to the distal (third) phalanx of the thumb.

History 1

Thumb3TposeAdjustment

TypeDefault
CFrame0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0, 1

CoordinateFrame applied to Thumb3 to normalize the joint into its canonical T-pose orientation before retargeting or solving.

History 1

ThumbRange

TypeDefault
Vector30, 0, 0

A Vector3 describing the motion range of the thumb, used by the finger solver and scalable-property system.

History 1

ThumbSize

TypeDefault
float0

Scale factor for the thumb, used when the rig is scaled through the scalable-property system.

History 1

Settings