Reference API Roblox

Engine API

Website

Related

Reference API Roblox

KeyframeSequenceProvider

Provides functions to load and preview KeyframeSequence.

This class is not replicated. Its interface does not cross the network boundary.
This class is not creatable. Instances of this class cannot be created with Instance.new.
This class is a service. It is a singleton that may be acquired with GetService.
Memory categoryAnimation
Tags: [NotCreatable, Service, NotReplicated]

Member index 7

HistoryMember
462GetAnimations(userId: int64): Instance
645GetKeyframeSequence(assetId: ContentId): Instance
645GetKeyframeSequenceAsync(assetId: ContentId): Instance
553GetKeyframeSequenceById(assetId: int64, useCache: bool): Instance
462GetMemStats(): Dictionary
645RegisterActiveKeyframeSequence(keyframeSequence: Instance): ContentId
645RegisterKeyframeSequence(keyframeSequence: Instance): ContentId
inherited from Instance
553Archivable: bool
635Capabilities: SecurityCapabilities
553Name: string
553Parent: Instance
635Sandboxed: bool
616UniqueId: UniqueId
576AddTag(tag: string): null
573ClearAllChildren(): null
462Clone(): Instance
573Destroy(): null
486FindFirstAncestor(name: string): Instance
486FindFirstAncestorOfClass(className: string): Instance
486FindFirstAncestorWhichIsA(className: string): Instance
486FindFirstChild(name: string, recursive: bool = false): Instance
486FindFirstChildOfClass(className: string): Instance
486FindFirstChildWhichIsA(className: string, recursive: bool = false): Instance
486FindFirstDescendant(name: string): Instance
563GetActor(): Actor
486GetAttribute(attribute: string): Variant
462GetAttributeChangedSignal(attribute: string): RBXScriptSignal
631GetAttributes(): Dictionary
648GetChildren(): Instances
462GetDebugId(scopeLength: int = 4): string
486GetDescendants(): Array
486GetFullName(): string
641GetStyled(name: string): Variant
576GetTags(): Array
576HasTag(tag: string): bool
486IsAncestorOf(descendant: Instance): bool
486IsDescendantOf(ancestor: Instance): bool
580IsPropertyModified(name: string): bool
573Remove(): null
576RemoveTag(tag: string): null
580ResetPropertyToDefault(name: string): null
573SetAttribute(attribute: string, value: Variant): null
462WaitForChild(childName: string, timeOut: double): Instance
648children(): Instances
553clone(): Instance
573destroy(): null
553findFirstChild(name: string, recursive: bool = false): Instance
648getChildren(): Instances
553isDescendantOf(ancestor: Instance): bool
573remove(): null
462AncestryChanged(child: Instance, parent: Instance)
462AttributeChanged(attribute: string)
462ChildAdded(child: Instance)
462ChildRemoved(child: Instance)
462DescendantAdded(descendant: Instance)
462DescendantRemoving(descendant: Instance)
500Destroying()
553childAdded(child: Instance)
inherited from Object
647ClassName: string
647className: string
647GetPropertyChangedSignal(property: string): RBXScriptSignal
647IsA(className: string): bool
650isA(className: string): bool
647Changed(property: string)

Description

The KeyframeSequenceProvider service provides functions to load and preview KeyframeSequences. It includes a number of functions that are useful when working with Animations.

A KeyframeSequence stores a series of Poses that encode the hierarchy and motion of an animation. The animation data Roblox uses in the playback of an animation, referenced by the Animation.AnimationId property, can be constructed from a KeyframeSequence. KeyframeSequences are usually created by the Roblox Animation Editor but can be created through other plugins or even manually.

History 33

Members 7

GetAnimations

Parameters (1)
userIdint64
Returns (1)
Instance

This function returns an InventoryPages object which can be used to iterate over animations owned by a specific user.

This function has a number of potential uses, such as allowing users to browse and import animations into a custom animation plugin.

This function yields. It will block the calling thread until completion.
Thread safetyUnsafe

History 9

Tags: [Yields]

GetKeyframeSequence

Parameters (1)
assetIdContentId
Returns (1)
Instance

Returns a KeyframeSequence from a given asset URL.

This function is deprecated. It exists only for backward compatibility, and should not be used for new work. GetKeyframeSequenceAsync should be used instead.
SecurityPluginSecurity
Thread safetyUnsafe

History 6

Tags: [Deprecated]

GetKeyframeSequenceAsync

Parameters (1)
assetIdContentId
Returns (1)
Instance

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.

This function yields. It will block the calling thread until completion.
Thread safetyUnsafe

History 3

Tags: [Yields]

GetKeyframeSequenceById

Parameters (2)
assetIdint64
useCachebool
Returns (1)
Instance

Returns a KeyframeSequence from the supplied assetId. Can optionally cache to reduce unnecessary loading freezes.

This function is deprecated. It exists only for backward compatibility, and should not be used for new work. GetKeyframeSequenceAsync should be used instead.
SecurityPluginSecurity
Thread safetyUnsafe

History 6

Tags: [Deprecated]

GetMemStats

Parameters (0)
No parameters.
Returns (1)
Dictionary
SecurityRobloxScriptSecurity
Thread safetyUnsafe

History 2

RegisterActiveKeyframeSequence

Parameters (1)
keyframeSequenceInstance
Returns (1)
ContentId

Generates a temporary asset ID from a KeyframeSequence that can be used for localized testing of an animation.

This function performs the same function to KeyframeSequenceProvider:RegisterKeyframeSequence() however this function generates an active:// URL instead of a hash.

The ID generated can be used in an Animation.AnimationId property for testing.

The asset ID generated by this function is temporary and cannot be used outside of Studio. Developers wishing to generate an asset ID that can be used online should upload the KeyframeSequence to Roblox.

Thread safetyUnsafe

History 3

RegisterKeyframeSequence

Parameters (1)
keyframeSequenceInstance
Returns (1)
ContentId

Generates a temporary asset ID from a KeyframeSequence that can be used for localized testing of an animation.

This function performs the same function to KeyframeSequenceProvider:RegisterActiveKeyframeSequence() however this function generates a hash instead of an active:// URL.

The ID generated can be used for the Animation.AnimationId property to test animations.

The asset ID generated by this function is temporary and cannot be used outside of Studio. Developers wishing to generate an asset ID that can be used online should upload the KeyframeSequence to Roblox.

Thread safetyUnsafe

History 3

Settings