# DigitsRigDescription

Roblox Engine API class from Roblox Studio 0.744.0.7441077 (version-7aaa6838d36c4448).

- Inherits from, nearest first: [Instance](https://rapi.sleaze.dev/classes/Instance.md), [Object](https://rapi.sleaze.dev/classes/Object.md)
- Memory category: Animation
- HTML page: https://rapi.sleaze.dev/classes/DigitsRigDescription/
- Roblox documentation: https://create.roblox.com/docs/reference/engine/classes/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.

## Properties

### Side

```luau
DigitsRigDescription.Side: Enum.DigitsRigDescriptionSide = Enum.DigitsRigDescriptionSide.None
```

- Tags: Read capabilities: Animation

Which hand this description belongs to: `None`, `Left`, or `Right`.

### Index1

```luau
DigitsRigDescription.Index1: Instance
```

- Tags: Read capabilities: Animation

The instance mapped to the proximal (first) phalanx of the index finger.

### Index2

```luau
DigitsRigDescription.Index2: Instance
```

- Tags: Read capabilities: Animation

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

### Index3

```luau
DigitsRigDescription.Index3: Instance
```

- Tags: Read capabilities: Animation

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

### Middle1

```luau
DigitsRigDescription.Middle1: Instance
```

- Tags: Read capabilities: Animation

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

### Middle2

```luau
DigitsRigDescription.Middle2: Instance
```

- Tags: Read capabilities: Animation

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

### Middle3

```luau
DigitsRigDescription.Middle3: Instance
```

- Tags: Read capabilities: Animation

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

### Pinky1

```luau
DigitsRigDescription.Pinky1: Instance
```

- Tags: Read capabilities: Animation

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

### Pinky2

```luau
DigitsRigDescription.Pinky2: Instance
```

- Tags: Read capabilities: Animation

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

### Pinky3

```luau
DigitsRigDescription.Pinky3: Instance
```

- Tags: Read capabilities: Animation

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

### Ring1

```luau
DigitsRigDescription.Ring1: Instance
```

- Tags: Read capabilities: Animation

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

### Ring2

```luau
DigitsRigDescription.Ring2: Instance
```

- Tags: Read capabilities: Animation

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

### Ring3

```luau
DigitsRigDescription.Ring3: Instance
```

- Tags: Read capabilities: Animation

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

### Thumb1

```luau
DigitsRigDescription.Thumb1: Instance
```

- Tags: Read capabilities: Animation

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

### Thumb2

```luau
DigitsRigDescription.Thumb2: Instance
```

- Tags: Read capabilities: Animation

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

### Thumb3

```luau
DigitsRigDescription.Thumb3: Instance
```

- Tags: Read capabilities: Animation

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

### IndexRange

```luau
DigitsRigDescription.IndexRange: Vector3 = Vector3.zero
```

- Tags: Read capabilities: Animation

Motion range vector for the index finger used by the finger solver.

### MiddleRange

```luau
DigitsRigDescription.MiddleRange: Vector3 = Vector3.zero
```

- Tags: Read capabilities: Animation

Motion range vector for the middle finger used by the finger solver.

### PinkyRange

```luau
DigitsRigDescription.PinkyRange: Vector3 = Vector3.zero
```

- Tags: Read capabilities: Animation

Motion range vector for the pinky finger used by the finger solver.

### RingRange

```luau
DigitsRigDescription.RingRange: Vector3 = Vector3.zero
```

- Tags: Read capabilities: Animation

Motion range vector for the ring finger used by the finger solver.

### ThumbRange

```luau
DigitsRigDescription.ThumbRange: Vector3 = Vector3.zero
```

- Tags: Read capabilities: Animation

Motion range vector for the thumb used by the finger solver.

### IndexSize

```luau
DigitsRigDescription.IndexSize: number = 0
```

- Tags: Read capabilities: Animation

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

### MiddleSize

```luau
DigitsRigDescription.MiddleSize: number = 0
```

- Tags: Read capabilities: Animation

Scale factor for the middle finger used by the scalable-property system.

### PinkySize

```luau
DigitsRigDescription.PinkySize: number = 0
```

- Tags: Read capabilities: Animation

Scale factor for the pinky finger used by the scalable-property system.

### RingSize

```luau
DigitsRigDescription.RingSize: number = 0
```

- Tags: Read capabilities: Animation

Scale factor for the ring finger used by the scalable-property system.

### ThumbSize

```luau
DigitsRigDescription.ThumbSize: number = 0
```

- Tags: Read capabilities: Animation

Scale factor for the thumb used by the scalable-property system.

### Index1TposeAdjustment

```luau
DigitsRigDescription.Index1TposeAdjustment: CFrame = CFrame.identity
```

- Tags: Read capabilities: Animation

CFrame applied to [`Index1`](https://rapi.sleaze.dev/classes/DigitsRigDescription.md) to normalize the joint into its canonical T-pose orientation before retargeting or solving.

### Index2TposeAdjustment

```luau
DigitsRigDescription.Index2TposeAdjustment: CFrame = CFrame.identity
```

- Tags: Read capabilities: Animation

CFrame applied to [`Index2`](https://rapi.sleaze.dev/classes/DigitsRigDescription.md) to normalize the joint into its canonical T-pose orientation before retargeting or solving.

### Index3TposeAdjustment

```luau
DigitsRigDescription.Index3TposeAdjustment: CFrame = CFrame.identity
```

- Tags: Read capabilities: Animation

CFrame applied to [`Index3`](https://rapi.sleaze.dev/classes/DigitsRigDescription.md) to normalize the joint into its canonical T-pose orientation before retargeting or solving.

### Middle1TposeAdjustment

```luau
DigitsRigDescription.Middle1TposeAdjustment: CFrame = CFrame.identity
```

- Tags: Read capabilities: Animation

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

### Middle2TposeAdjustment

```luau
DigitsRigDescription.Middle2TposeAdjustment: CFrame = CFrame.identity
```

- Tags: Read capabilities: Animation

CFrame applied to [`Middle2`](https://rapi.sleaze.dev/classes/DigitsRigDescription.md) to normalize the joint into its canonical T-pose orientation before retargeting or solving.

### Middle3TposeAdjustment

```luau
DigitsRigDescription.Middle3TposeAdjustment: CFrame = CFrame.identity
```

- Tags: Read capabilities: Animation

CFrame applied to [`Middle3`](https://rapi.sleaze.dev/classes/DigitsRigDescription.md) to normalize the joint into its canonical T-pose orientation before retargeting or solving.

### Pinky1TposeAdjustment

```luau
DigitsRigDescription.Pinky1TposeAdjustment: CFrame = CFrame.identity
```

- Tags: Read capabilities: Animation

CFrame applied to [`Pinky1`](https://rapi.sleaze.dev/classes/DigitsRigDescription.md) to normalize the joint into its canonical T-pose orientation before retargeting or solving.

### Pinky2TposeAdjustment

```luau
DigitsRigDescription.Pinky2TposeAdjustment: CFrame = CFrame.identity
```

- Tags: Read capabilities: Animation

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

### Pinky3TposeAdjustment

```luau
DigitsRigDescription.Pinky3TposeAdjustment: CFrame = CFrame.identity
```

- Tags: Read capabilities: Animation

CFrame applied to [`Pinky3`](https://rapi.sleaze.dev/classes/DigitsRigDescription.md) to normalize the joint into its canonical T-pose orientation before retargeting or solving.

### Ring1TposeAdjustment

```luau
DigitsRigDescription.Ring1TposeAdjustment: CFrame = CFrame.identity
```

- Tags: Read capabilities: Animation

CFrame applied to [`Ring1`](https://rapi.sleaze.dev/classes/DigitsRigDescription.md) to normalize the joint into its canonical T-pose orientation before retargeting or solving.

### Ring2TposeAdjustment

```luau
DigitsRigDescription.Ring2TposeAdjustment: CFrame = CFrame.identity
```

- Tags: Read capabilities: Animation

CFrame applied to [`Ring2`](https://rapi.sleaze.dev/classes/DigitsRigDescription.md) to normalize the joint into its canonical T-pose orientation before retargeting or solving.

### Ring3TposeAdjustment

```luau
DigitsRigDescription.Ring3TposeAdjustment: CFrame = CFrame.identity
```

- Tags: Read capabilities: Animation

CFrame applied to [`Ring3`](https://rapi.sleaze.dev/classes/DigitsRigDescription.md) to normalize the joint into its canonical T-pose orientation before retargeting or solving.

### Thumb1TposeAdjustment

```luau
DigitsRigDescription.Thumb1TposeAdjustment: CFrame = CFrame.identity
```

- Tags: Read capabilities: Animation

CFrame applied to [`Thumb1`](https://rapi.sleaze.dev/classes/DigitsRigDescription.md) to normalize the joint into its canonical T-pose orientation before retargeting or solving.

### Thumb2TposeAdjustment

```luau
DigitsRigDescription.Thumb2TposeAdjustment: CFrame = CFrame.identity
```

- Tags: Read capabilities: Animation

CFrame applied to [`Thumb2`](https://rapi.sleaze.dev/classes/DigitsRigDescription.md) to normalize the joint into its canonical T-pose orientation before retargeting or solving.

### Thumb3TposeAdjustment

```luau
DigitsRigDescription.Thumb3TposeAdjustment: CFrame = CFrame.identity
```

- Tags: Read capabilities: Animation

CFrame applied to [`Thumb3`](https://rapi.sleaze.dev/classes/DigitsRigDescription.md) to normalize the joint into its canonical T-pose orientation before retargeting or solving.

## Methods

### GetFingerControl

```luau
DigitsRigDescription:GetFingerControl(fingerIndex: number): Vector3
```

- Tags: Capabilities: Animation

Returns the current forward-kinematics control vector for the specified finger.

Parameters:

- `fingerIndex`: 1-based index of the finger to query (1 = Thumb, 2 = Index, 3 = Middle, 4 = Ring, 5 = Pinky).

Returns: The control [`Vector3`](https://rapi.sleaze.dev/index/types/Vector3.md) whose X is extension [0, 1], Y is lateral rotation [-1, 1], and Z is axial rotation [-1, 1].

### GetFingerTip

```luau
DigitsRigDescription:GetFingerTip(fingerIndex: number): Vector3
```

- Tags: Capabilities: Animation

Returns the world-space position of the fingertip for the specified finger.

Parameters:

- `fingerIndex`: 1-based index of the finger to query (1 = Thumb, 2 = Index, 3 = Middle, 4 = Ring, 5 = Pinky).

Returns: The world-space [`Vector3`](https://rapi.sleaze.dev/index/types/Vector3.md) position of the fingertip. Currently always returns `Vector3.zero`.

### GetJoint

```luau
DigitsRigDescription:GetJoint(label: Enum.RigLabel): Instance
```

- Tags: Roblox script security, Thread safe, Capabilities: Animation

### GetJointLabels

```luau
DigitsRigDescription:GetJointLabels(): { any }
```

- Tags: Roblox script security, Thread safe, Capabilities: Animation

### GetTposeAdjustment

```luau
DigitsRigDescription:GetTposeAdjustment(label: Enum.RigLabel): CFrame
```

- Tags: Roblox script security, Thread safe, Capabilities: Animation

### SetFingerControl

```luau
DigitsRigDescription:SetFingerControl(fingerIndex: number, control: Vector3)
```

- Tags: Capabilities: Animation

Drives the three-joint chain of the specified finger using forward kinematics.

Parameters:

- `fingerIndex`: 1-based index of the finger to drive (1 = Thumb, 2 = Index, 3 = Middle, 4 = Ring, 5 = Pinky).
- `control`: A [`Vector3`](https://rapi.sleaze.dev/index/types/Vector3.md) whose X sets extension [0, 1], Y sets lateral rotation [-1, 1], and Z sets axial rotation [-1, 1]; each component is clamped before application.

### SetFingerTip

```luau
DigitsRigDescription:SetFingerTip(fingerIndex: number, point: Vector3)
```

- Tags: Capabilities: Animation

Moves the fingertip of the specified finger toward a world-space target using inverse kinematics.

Parameters:

- `fingerIndex`: 1-based index of the finger to solve (1 = Thumb, 2 = Index, 3 = Middle, 4 = Ring, 5 = Pinky).
- `point`: World-space [`Vector3`](https://rapi.sleaze.dev/index/types/Vector3.md) target position for the fingertip.

### SetJoint

```luau
DigitsRigDescription:SetJoint(label: Enum.RigLabel, joint: Instance)
```

- Tags: Thread safe, Capabilities: Animation + PluginOrOpenCloud

### SetTposeAdjustment

```luau
DigitsRigDescription:SetTposeAdjustment(label: Enum.RigLabel, transform: CFrame)
```

- Tags: Roblox script security, Thread safe, Capabilities: Animation

## Inherited members

- From [Instance](https://rapi.sleaze.dev/classes/Instance.md): `Archivable`, `archivable`, `Attributes`, `AttributesReplicate`, `AttributesSerialize`, `HistoryId`, `Name`, `Parent`, `PredictionMode`, `PropertyStatusStudio`, `RobloxLocked`, `SerializedOverrides`, `SourceAssetId`, `Tags`, `UniqueId`, `numExpectedDirectChildren`, `DataCost`, `Capabilities`, `DefinesCapabilities`, `IsInSandbox`, `Sandboxed`, `AddTag`, `ClearAllChildren`, `Clone`, `Destroy`, `FindFirstAncestor`, `FindFirstAncestorOfClass`, `FindFirstAncestorWhichIsA`, `FindFirstChild`, `FindFirstChildOfClass`, `FindFirstChildWhichIsA`, `FindFirstDescendant`, `GetActor`, `GetAttribute`, `GetAttributeChangedSignal`, `GetAttributes`, `GetChildren`, `GetDebugId`, `GetDescendants`, `GetFullName`, `GetStyled`, `GetStyledPropertyChangedSignal`, `GetTags`, `HasTag`, `IsAncestorOf`, `IsDescendantOf`, `IsPropertyModified`, `QueryDescendants`, `RemoveTag`, `ResetPropertyToDefault`, `SetAttribute`, `WaitForChild`, `Remove`, `children`, `clone`, `destroy`, `findFirstChild`, `getChildren`, `isDescendantOf`, `remove`, `AncestryChanged`, `AttributeChanged`, `ChildAdded`, `ChildRemoved`, `DescendantAdded`, `DescendantRemoving`, `Destroying`, `StyledPropertiesChanged`, `childAdded`
- From [Object](https://rapi.sleaze.dev/classes/Object.md): `ClassName`, `className`, `GetPropertyChangedSignal`, `IsA`, `isA`, `Changed`