rojo/.cursor/rules/roblox/reference/engine/classes/KeyframeSequenceProvider.yaml

# This file is automatically generated. Please don't edit it manually.
# To submit a bug report on the content, see
# https://devforum.roblox.com/c/bug-reports/documentation-issues/72

name: KeyframeSequenceProvider
type: class
memory_category: Animation
summary: |
  Provides functions to load and preview `Class.KeyframeSequence`.
description: |
  The **KeyframeSequenceProvider** service provides functions to load and
  preview `Class.KeyframeSequence|KeyframeSequences`. It includes a number of
  functions that are useful when working with `Class.Animation|Animations`.

  A `Class.KeyframeSequence` stores a series of `Class.Pose|Poses` that encode
  the hierarchy and motion of an animation. The animation data Roblox uses in
  the playback of an animation, referenced by the `Class.Animation.AnimationId`
  property, can be constructed from a `Class.KeyframeSequence`.
  `Class.KeyframeSequence|KeyframeSequences` are usually created by the Roblox
  [Animation Editor](../../../animation/editor.md) but can be created through
  other plugins or even manually.
code_samples:
  - KeyframeSequenceProvider-RegisterKeyframeSequence
inherits:
  - Instance
descendants: []
tags:
  - NotCreatable
  - Service
  - NotReplicated
deprecation_message: |
  This service is deprecated and does not support the newer
  `Class.AnimationClip`. It's recommended to use `Class.AnimationClipProvider`
  instead.
properties: []
methods:
  - name: KeyframeSequenceProvider:GetAnimationsAsync
    summary: |
      This function returns an `Class.InventoryPages` object which can be used
      to iterate over animations owned by a specific user.
    description: |
      This function returns an `Class.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.
    code_samples:
      - KeyframeSequenceProvider-GetAnimations
    parameters:
      - name: userId
        type: int64
        default:
        summary: |
          The user ID of the user.
    returns:
      - type: Instance
        summary: |
          An `Class.InventoryPages` of animations.
    tags:
      - Yields
    deprecation_message: ''
    security: None
    thread_safety: Unsafe
    capabilities:
      - Animation
  - name: KeyframeSequenceProvider:GetAnimations
    summary: |
      This function returns an `Class.InventoryPages` object which can be used
      to iterate over animations owned by a specific user.
    description: ''
    code_samples:
      - KeyframeSequenceProvider-GetAnimations
    parameters:
      - name: userId
        type: int64
        default:
        summary: |
          The user ID of the user.
    returns:
      - type: Instance
        summary: |
          An `Class.InventoryPages` of animations.
    tags:
      - Yields
      - Deprecated
    deprecation_message: ''
    security: None
    thread_safety: Unsafe
    capabilities:
      - Animation
  - name: KeyframeSequenceProvider:GetKeyframeSequence
    summary: |
      Returns a `Class.KeyframeSequence` from a given asset URL.
    description: |
      Returns a `Class.KeyframeSequence` from a given asset URL.
    code_samples: []
    parameters:
      - name: assetId
        type: ContentId
        default:
        summary: |
          The content ID of the animation.
    returns:
      - type: Instance
        summary: |
          The `Class.KeyframeSequence` found.
    tags:
      - Deprecated
    deprecation_message: |
      This function is deprecated and can lead to the game freezing until the
      animation is loaded. Developers are recommended to use
      `Class.KeyframeSequenceProvider:GetKeyframeSequenceAsync()` instead.
    security: PluginSecurity
    thread_safety: Unsafe
    capabilities:
      - Animation
  - name: KeyframeSequenceProvider:GetKeyframeSequenceAsync
    summary: |
      Returns a KeyframeSequence based on the specified assetId asynchronously.
    description: |
      GetKeyframeSequenceAsync returns a `Class.KeyframeSequence` based on the
      specified assetId. The assetId must correspond to an animation. The
      function will yield until the `Class.KeyframeSequence` is loaded from the
      website. Because this is a webcall it should wrapped in a pcall.
    code_samples:
      - KeyframeSequenceProvider-GetKeyframeSequenceAsync1
    parameters:
      - name: assetId
        type: ContentId
        default:
        summary: |
          The content ID of the animation.
    returns:
      - type: Instance
        summary: |
          The `Class.KeyframeSequence` found.
    tags:
      - Yields
    deprecation_message: ''
    security: None
    thread_safety: Unsafe
    capabilities:
      - Animation
  - name: KeyframeSequenceProvider:GetKeyframeSequenceById
    summary: |
      Returns a `Class.KeyframeSequence` from the supplied assetId.
    description: |
      Returns a `Class.KeyframeSequence` from the supplied assetId. Can
      optionally cache to reduce unnecessary loading freezes.
    code_samples: []
    parameters:
      - name: assetId
        type: int64
        default:
        summary: |
          The content ID of the animation.
      - name: useCache
        type: boolean
        default:
        summary: |
          True if a cached version can be returned.
    returns:
      - type: Instance
        summary: |
          The `Class.KeyframeSequence` found.
    tags:
      - Deprecated
    deprecation_message: |
      This function is deprecated and can lead to the game freezing until the
      animation is loaded. Developers are recommended to use
      `Class.KeyframeSequenceProvider:GetKeyframeSequenceAsync()` instead.
    security: PluginSecurity
    thread_safety: Unsafe
    capabilities:
      - Animation
  - name: KeyframeSequenceProvider:RegisterActiveKeyframeSequence
    summary: |
      Generates a temporary asset ID from a `Class.KeyframeSequence` that can be
      used for localized testing of an animation. Generates an _active://_ URL.
    description: |
      Generates a temporary asset ID from a `Class.KeyframeSequence` that can be
      used for localized testing of an animation.

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

      The ID generated can be used in an `Class.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 `Class.KeyframeSequence` to Roblox.
    code_samples:
      - KeyframeSequenceProvider-RegisterKeyframeSequence
    parameters:
      - name: keyframeSequence
        type: Instance
        default:
        summary: |
          The `Class.KeyframeSequence` to be used.
    returns:
      - type: ContentId
        summary: |
          A temporary asset ID generated for localized animation playback.
    tags: []
    deprecation_message: ''
    security: None
    thread_safety: Unsafe
    capabilities:
      - Animation
  - name: KeyframeSequenceProvider:RegisterKeyframeSequence
    summary: |
      Generates a temporary asset ID from a `Class.KeyframeSequence` that can be
      used for localized testing of an animation. Generates a hash.
    description: |
      Generates a temporary asset ID from a `Class.KeyframeSequence` that can be
      used for localized testing of an animation.

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

      The ID generated can be used for the `Class.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 `Class.KeyframeSequence` to Roblox.
    code_samples:
      - KeyframeSequenceProvider-RegisterKeyframeSequence1
    parameters:
      - name: keyframeSequence
        type: Instance
        default:
        summary: |
          The `Class.KeyframeSequence` to be used.
    returns:
      - type: ContentId
        summary: |
          A temporary asset ID generated for localized animation playback.
    tags: []
    deprecation_message: ''
    security: None
    thread_safety: Unsafe
    capabilities:
      - Animation
events: []
callbacks: []