GetKeyframeSequenceAsync

Yields

This is a yielding function. When called, it will pause the Lua thread that called the function until a result is ready to be returned, without interrupting other scripts.

Unsafe

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

Function of:

KeyframeSequenceProvider

Description:

GetKeyframeSequenceAsync returns a KeyframeSequence based on the specified assetId. The assetId must correspond to an animation. The function will yield until the KeyframeSequence is loaded from the website. Because this is a webcall it should wrapped in a pcall.

Parameters

Name	Type	Default	Description
Name assetId	Type Content	Default	Summary The content ID of the animation.

Returns

Return Type	Summary
Return Type Instance	Summary The `KeyframeSequence` found.

Code Samples

KeyframeSequenceProvider:GetKeyframeSequenceAsync

			
				KeyframeSequenceProvider:GetKeyframeSequenceAsync

				Expected Output
			
				Expand
				
			local KeyframeSequence = game:GetService("KeyframeSequenceProvider")
local animation = "rbxassetid://507771019"
local keyframes = {}
local success = pcall(function()
	keyframes = KeyframeSequence:GetKeyframeSequenceAsync(animation)
end)
if success then
	local keyframeTable = keyframes:GetKeyframes()
	for key,value in ipairs(keyframeTable) do
		print("The time of keyframe number",key,"is",value.Time)
	end
else
	print("error getting KeyframeSequence")
end
		
				Copy Code
			
				Light Theme

GetKeyframeSequenceAsync

Parameters

assetId

Returns

Instance

Code Samples

KeyframeSequenceProvider:GetKeyframeSequenceAsync