Pose
Holds the CFrame applied to the Motor6D connected to its associated BasePart. The part which is controlled depends on the name of the Pose.
| Memory category | Animation |
|---|
Member index 5
Removed member index 3
| History | Member | |
|---|---|---|
| 455 | EasingDirection: PoseEasingDirection | |
| 455 | EasingStyle: PoseEasingStyle | |
| 455 | Weight: float |
Description
A Pose holds the CFrame applied to the Motor6D connected to its associated BasePart. The part which is controlled depends on the name of the Pose.
Poses are the fundamental building blocks of animations and, with Keyframes,
make up KeyframeSequences.
Poses, joints and hierarchy
Although a Pose is assigned to a BasePart by name, the object manipulated during animation playback is actually the Motor6D connected to this part. Animation rigs branch out from the model's root part through such joints.
In a R15 character rig, the root part is the HumanoidRootPart. The LowerTorso is connected to the HumanoidRootPart by the a motor named 'Root'. Therefore, the CFrame of a Pose named 'LowerTorso' in a Keyframe would be applied to the motor named 'Root', and not the LowerTorso itself.
Poses are arranged in a Keyframe based on joint hierarchy. This means, the Pose's CFrame is applied to the motor connecting the part associated with the pose to the part associated with the pose's parent. See below for a visual example of the structure of Poses on a R15 character.
Pose CFrame
The Roblox animation system applies Pose.CFrame to the corresponding Motor6D by manipulating the relative transformation of the motor, the Motor6D.Transform property. The original C0 and C1 values are not changed.
History 29
- 648 Change ReturnType of GetSubPoses from Objects to Instances
- 573 Change ReturnType of RemoveSubPose from void to null
- 573 Change ReturnType of AddSubPose from void to null
- 553 Change Default of MaskWeight from to 0
- 553 Change Default of CFrame from to
- 486 Change ThreadSafety of MaskWeight from ReadOnly to ReadSafe
- 486 Change ThreadSafety of CFrame from ReadOnly to ReadSafe
- 462 Change ThreadSafety of RemoveSubPose from to Unsafe
- 462 Change ThreadSafety of GetSubPoses from to Unsafe
- 462 Change ThreadSafety of AddSubPose from to Unsafe
- 462 Change ThreadSafety of MaskWeight from to ReadOnly
- 462 Change ThreadSafety of CFrame from to ReadOnly
- 455 Remove Weight
- 455 Remove EasingStyle
- 455 Remove EasingDirection
- 455 Change Superclass of Pose from Instance to PoseBase
- 312 Change Tags of MaskWeight from [NotReplicated] to [NotReplicated, Deprecated]
- 311 Change Tags of MaskWeight from [NotReplicated, Deprecated] to [NotReplicated]
- 312 Change Tags of MaskWeight from [NotReplicated] to [NotReplicated, Deprecated]
- 244 Add EasingStyle
- 244 Add EasingDirection
- 55 Change Tags of Pose from [preliminary] to []
- 47 Add RemoveSubPose
- 47 Add GetSubPoses
- 47 Add AddSubPose
- 47 Add Weight
- 47 Add MaskWeight
- 47 Add CFrame
- 47 Add Pose
Members 5
AddSubPose
| Parameters (1) | ||
|---|---|---|
| pose | Instance | |
| Returns (1) | ||
| null | ||
Adds a sub Pose to the Pose by parenting it to it. It is functionally identical to setting the new pose's Instance.Parent to the pose.
Note, this function will not error when an instance other than a Pose is given as the pose parameter and will parent it successfully.
| Thread safety | Unsafe |
|---|
History 3
- 573 Change ReturnType of AddSubPose from void to null
- 462 Change ThreadSafety of AddSubPose from to Unsafe
- 47 Add AddSubPose
CFrame
| Type | Default | |
|---|---|---|
| CFrame | ||
This CFrame applies to the Motor6D corresponding with the Pose when the Motor6D.Transform is changed. The original Motor6D.C0 and Motor6D.C1 values are not changed.
Pose objects are arranged in a Keyframe based on joint hierarchy. This means, that the Pose.CFrame is applied to the motor connecting the part associated with the pose to the part associated with the pose's parent.
| Thread safety | ReadSafe |
|---|---|
| Category | Data |
| Loaded/Saved | true |
GetSubPoses
| Parameters (0) | ||
|---|---|---|
| No parameters. | ||
| Returns (1) | ||
| Instances | ||
Returns an array containing all sub Poses that have been added to a Pose. This is functionally the same as using the Instance:GetChildren() function on the Pose.
Note: this function returns all children of the Pose, including non Pose Instances if any are present.
| Thread safety | Unsafe |
|---|
History 3
- 648 Change ReturnType of GetSubPoses from Objects to Instances
- 462 Change ThreadSafety of GetSubPoses from to Unsafe
- 47 Add GetSubPoses
MaskWeight
| Type | Default | |
|---|---|---|
| float | 0 | |
| Thread safety | ReadSafe |
|---|---|
| Category | Data |
| Loaded/Saved | true/false |
History 7
- 553 Change Default of MaskWeight from to 0
- 486 Change ThreadSafety of MaskWeight from ReadOnly to ReadSafe
- 462 Change ThreadSafety of MaskWeight from to ReadOnly
- 312 Change Tags of MaskWeight from [NotReplicated] to [NotReplicated, Deprecated]
- 311 Change Tags of MaskWeight from [NotReplicated, Deprecated] to [NotReplicated]
- 312 Change Tags of MaskWeight from [NotReplicated] to [NotReplicated, Deprecated]
- 47 Add MaskWeight
RemoveSubPose
| Parameters (1) | ||
|---|---|---|
| pose | Instance | |
| Returns (1) | ||
| null | ||
Removes a sub Pose from the Pose by parenting it to nil. This is functionally identical to setting the new pose's Instance.Parent to nil.
Note: If an Instance other than Pose is used as a Pose parameter, this function removes that Instance and does not provide an error.
| Thread safety | Unsafe |
|---|
History 3
- 573 Change ReturnType of RemoveSubPose from void to null
- 462 Change ThreadSafety of RemoveSubPose from to Unsafe
- 47 Add RemoveSubPose
Removed members 3
EasingDirection
| Type | Default | |
|---|---|---|
| PoseEasingDirection | ||
| Category | Data |
|---|---|
| Loaded/Saved | true |
History 2
- 455 Remove EasingDirection
- 244 Add EasingDirection
EasingStyle
| Type | Default | |
|---|---|---|
| PoseEasingStyle | ||
| Category | Data |
|---|---|
| Loaded/Saved | true |
History 2
- 455 Remove EasingStyle
- 244 Add EasingStyle
Weight
| Type | Default | |
|---|---|---|
| float | ||
| Category | Data |
|---|---|
| Loaded/Saved | true |