AddKeyframe

Unsafe

For thread safety, this property is not safe to read in an unsynchronized thread.

Function of:

Description:

This function adds a Keyframe to the KeyframeSequence by parenting it to the KeyframeSequence. It is functionally identical to setting the Keyframe’s Instance/Parent to the KeyframeSequence.

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

Parameters

Name	Type	Default	Description
Name keyframe	Type Instance	Default	Summary The `Keyframe` to be added.

Returns

Return Type	Summary
Return Type void	Summary

Code Samples

KeyframeSequence Instantiation

This sample demonstrates how a basic KeyframeSequence can be created.

			
				KeyframeSequence Instantiation

				Expected Output
			
				Expand
				
			-- create the keyframesequence
local keyframeSequence = Instance.new("KeyframeSequence")
keyframeSequence.Loop = false
keyframeSequence.Priority = Enum.AnimationPriority.Action

--  create a keyframe
local keyframe = Instance.new("Keyframe")
keyframe.Time = 0

-- create sample poses
local rootPose = Instance.new("Pose")
rootPose.Name = "HumanoidRootPart"
rootPose.Weight = 0

local lowerTorsoPose = Instance.new("Pose")
lowerTorsoPose.Name = "LowerTorso"
lowerTorsoPose.Weight = 1

-- set the sequence hierarchy
rootPose:AddSubPose(lowerTorsoPose) -- lowerTorsoPose.Parent = rootPose
keyframe:AddPose(rootPose) -- rootPose.Parent = keyframe
keyframeSequence:AddKeyframe(keyframe) -- keyframe.Parent = keyframeSequence

-- parent the sequence 
keyframeSequence.Parent = workspace
		
				Copy Code
			
				Light Theme

AddKeyframe

Parameters

keyframe

Returns

void

Code Samples

KeyframeSequence Instantiation