Roblox UtilitiesDevlHub Roblox Documentation

Class

Keyframe

Inherits
Instance › Object
Memory category
Animation

A Keyframe holds the Poses applied to joints in a Model at a given point of time in an animation. Keyframes are interpolated between during animation playback.

A Keyframe holds the Poses applied to joints in a Model at a given point of time in an animation. Keyframes are interpolated between during animation playback.

Note, in most cases developers do not need to manipulate KeyframeSequences as the animation editor covers most animation functionality. However, in some cases a developer may wish to generate an animation from a Script or build their own plugin.

Structure#

Keyframes are held within a KeyframeSequence and contain Pose objects. The poses are named in accordance with the BaseParts they correspond to and are structured in terms of joint hierarchy. This means each Pose is parented to the Pose corresponding to the part it is attached to.

Note, as Poses are named in accordance with the BaseParts they correspond to, animations require distinct part names to play correctly.

Interpolation#

During animation playback the poses in different keyframes are interpolated between. This allows a smooth animation to be created without needing to define every frame. Note, the style of interpolation is determined in the Pose object. The Keyframe object merely holds the Poses at a defined point of time in the animation (Keyframe.Time).

Properties 1#

TimefloatThe Keyframe time position (in seconds) in an animation. This determines the time at which the Poses inside the keyframe will be shown.ReadSafe

Time: float#

ReadSafe

This property gives the Keyframe time position (in seconds) in an animation. This determines the time at which the Poses inside the keyframe will be shown.

Note the Keyframe with the highest time value in a KeyframeSequence is used to determine the length of the animation.

Methods 6#

AddMarkerAdds a KeyframeMarker to the Keyframe by parenting it to the keyframe.
AddPoseAdds a Pose to the Keyframe by parenting it to the keyframe.
GetMarkersReturns an array containing all KeyframeMarkers that have been added to the Keyframe.
GetPosesReturns an array containing all Poses that have been added to a Keyframe.
RemoveMarkerRemoves a KeyframeMarker from the Keyframe by settings its Instance.Parent to nil.
RemovePoseRemoves a Pose from the Keyframe by setting its Instance.Parent to nil.

AddMarker(marker: Instance): ()#

This function adds a KeyframeMarker to the Keyframe by parenting it to the keyframe. It is functionally identical to setting the marker's Instance.Parent to the Keyframe.

Note, this function will not error when an instance other than a KeyframeMarker is given as the parameter and will parent it successfully.

More about Keyframes#

Keyframe names do not need to be unique. For example, if an Animation has three keyframes named "Particles" the connected event returned by AnimationTrack:GetMarkerReachedSignal() will fire each time one of these keyframes is reached.

Keyframe names can be set in the Roblox Animation Editor when creating or editing an animation. They cannot however be set by a Script on an existing animation prior to playing it.

See also:

NameTypeDefaultDescription
markerInstanceThe KeyframeMarker being parented to the Keyframe.
Returns
  • ()

AddPose(pose: Instance): ()#

This function adds a Pose to the Keyframe by parenting it to the keyframe. It is functionally identical to setting the pose's Instance.Parent to the keyframe.

Note, this function will not error when an instance other than a Pose is given as the pose parameter and will parent it successfully.

NameTypeDefaultDescription
poseInstanceThe Pose to be added.
Returns
  • ()

GetMarkers(): List<KeyframeMarker>#

This function returns an array containing all KeyframeMarkers that have been added to the Keyframe. Note, this function will only return instances of type KeyframeMarker.

More about Keyframes#

Keyframe names do not need to be unique. For example, if an Animation has three keyframes named "Particles" the connected event returned by AnimationTrack:GetMarkerReachedSignal() will fire each time one of these keyframes is reached.

Keyframe names can be set in the Roblox Animation Editor when creating or editing an animation. They cannot however be set by a Script on an existing animation prior to playing it.

See also:

Returns

GetPoses(): List<Pose>#

This function returns an array containing all Poses that have been added to a Keyframe.

Returns
  • List<Pose> — An array of Poses.

RemoveMarker(marker: Instance): ()#

This function removes a KeyframeMarker from the Keyframe by settings its Instance.Parent to nil.

The KeyframeMarker's Instance.Parent is set to nil but it is not destroyed. This means, provided the marker is referenced it can be re-parented later.

Note, this function will not error when an instance other than a KeyframeMarker is given as the parameter.

More about Keyframes#

Keyframe names do not need to be unique. For example, if an Animation has three keyframes named "Particles" the connected event returned by AnimationTrack:GetMarkerReachedSignal() will fire each time one of these keyframes is reached.

Keyframe names can be set in the Roblox Animation Editor when creating or editing an animation. They cannot however be set by a Script on an existing animation prior to playing it.

See also:

NameTypeDefaultDescription
markerInstanceThe marker being removed from the Keyframe.
Returns
  • ()

RemovePose(pose: Instance): ()#

This function removes a Pose from the Keyframe by setting its Instance.Parent to nil without destroying it. This means the provided the pose is referenced and it can be re-parented later.

Note, this function will not error when an instance other than a Pose is given as the pose parameter.

NameTypeDefaultDescription
poseInstanceThe Pose to be removed.
Returns
  • ()

Inherited members#

Inherited from Instance 58
Properties (10)

Archivable, archivable, Capabilities, IsInSandbox, Name, Parent, PredictionMode, RobloxLocked, Sandboxed, UniqueId

Methods (39)

AddTag, children, ClearAllChildren, Clone, clone, Destroy, destroy, FindFirstAncestor, FindFirstAncestorOfClass, FindFirstAncestorWhichIsA, FindFirstChild, findFirstChild, FindFirstChildOfClass, FindFirstChildWhichIsA, FindFirstDescendant, GetActor, GetAttribute, GetAttributeChangedSignal, GetAttributes, GetChildren, getChildren, GetDebugId, GetDescendants, GetFullName, GetStyled, GetStyledPropertyChangedSignal, GetTags, HasTag, IsAncestorOf, IsDescendantOf, isDescendantOf, IsPropertyModified, QueryDescendants, Remove, remove, RemoveTag, ResetPropertyToDefault, SetAttribute, WaitForChild

Events (9)

AncestryChanged, AttributeChanged, ChildAdded, childAdded, ChildRemoved, DescendantAdded, DescendantRemoving, Destroying, StyledPropertiesChanged

Inherited from Object 6
Properties (2)

ClassName, className

Methods (3)

GetPropertyChangedSignal, IsA, isA

Events (1)

Changed