docs.unity3d.com
Search Results for

    Show / Hide Table of Contents

    Class AnimationPlayableAsset

    A Playable Asset that represents a single AnimationClip clip.

    Inheritance
    object
    Object
    ScriptableObject
    PlayableAsset
    AnimationPlayableAsset
    Implements
    IPlayableAsset
    ITimelineClipAsset
    IPropertyPreview
    ISerializationCallbackReceiver
    Inherited Members
    ScriptableObject.SetDirty()
    ScriptableObject.CreateInstance(string)
    ScriptableObject.CreateInstance(Type)
    ScriptableObject.CreateInstance<T>()
    Object.GetInstanceID()
    Object.GetHashCode()
    Object.Equals(object)
    Object.Instantiate(Object, Vector3, Quaternion)
    Object.Instantiate(Object, Vector3, Quaternion, Transform)
    Object.Instantiate(Object)
    Object.Instantiate(Object, Transform)
    Object.Instantiate(Object, Transform, bool)
    Object.Instantiate<T>(T)
    Object.Instantiate<T>(T, Vector3, Quaternion)
    Object.Instantiate<T>(T, Vector3, Quaternion, Transform)
    Object.Instantiate<T>(T, Transform)
    Object.Instantiate<T>(T, Transform, bool)
    Object.Destroy(Object, float)
    Object.Destroy(Object)
    Object.DestroyImmediate(Object, bool)
    Object.DestroyImmediate(Object)
    Object.FindObjectsOfType(Type)
    Object.FindObjectsOfType(Type, bool)
    Object.FindObjectsByType(Type, FindObjectsSortMode)
    Object.FindObjectsByType(Type, FindObjectsInactive, FindObjectsSortMode)
    Object.DontDestroyOnLoad(Object)
    Object.DestroyObject(Object, float)
    Object.DestroyObject(Object)
    Object.FindSceneObjectsOfType(Type)
    Object.FindObjectsOfTypeIncludingAssets(Type)
    Object.FindObjectsOfType<T>()
    Object.FindObjectsByType<T>(FindObjectsSortMode)
    Object.FindObjectsOfType<T>(bool)
    Object.FindObjectsByType<T>(FindObjectsInactive, FindObjectsSortMode)
    Object.FindObjectOfType<T>()
    Object.FindObjectOfType<T>(bool)
    Object.FindFirstObjectByType<T>()
    Object.FindAnyObjectByType<T>()
    Object.FindFirstObjectByType<T>(FindObjectsInactive)
    Object.FindAnyObjectByType<T>(FindObjectsInactive)
    Object.FindObjectsOfTypeAll(Type)
    Object.FindObjectOfType(Type)
    Object.FindFirstObjectByType(Type)
    Object.FindAnyObjectByType(Type)
    Object.FindObjectOfType(Type, bool)
    Object.FindFirstObjectByType(Type, FindObjectsInactive)
    Object.FindAnyObjectByType(Type, FindObjectsInactive)
    Object.ToString()
    Object.name
    Object.hideFlags
    object.Equals(object, object)
    object.GetType()
    object.MemberwiseClone()
    object.ReferenceEquals(object, object)
    Namespace: UnityEngine.Timeline
    Assembly: Unity.Timeline.dll
    Syntax
    [Serializable]
    public class AnimationPlayableAsset : PlayableAsset, IPlayableAsset, ITimelineClipAsset, IPropertyPreview, ISerializationCallbackReceiver

    Properties

    applyFootIK

    Enable to apply foot IK to the AnimationClip when the target is humanoid.

    Declaration
    public bool applyFootIK { get; set; }
    Property Value
    Type Description
    bool

    clip

    The source animation clip

    Declaration
    public AnimationClip clip { get; set; }
    Property Value
    Type Description
    AnimationClip

    clipCaps

    Returns the capabilities of TimelineClips that contain a AnimationPlayableAsset

    Declaration
    public ClipCaps clipCaps { get; }
    Property Value
    Type Description
    ClipCaps

    duration

    Returns the duration required to play the animation clip exactly once

    Declaration
    public override double duration { get; }
    Property Value
    Type Description
    double
    Overrides
    PlayableAsset.duration

    eulerAngles

    The rotational offset of the clip, expressed in Euler angles

    Declaration
    public Vector3 eulerAngles { get; set; }
    Property Value
    Type Description
    Vector3

    loop

    Whether the source AnimationClip loops during playback

    Declaration
    public AnimationPlayableAsset.LoopMode loop { get; set; }
    Property Value
    Type Description
    AnimationPlayableAsset.LoopMode

    matchTargetFields

    Specifies which fields should be matched when aligning offsets.

    Declaration
    public MatchTargetFields matchTargetFields { get; set; }
    Property Value
    Type Description
    MatchTargetFields

    outputs

    Returns a description of the PlayableOutputs that may be created for this asset.

    Declaration
    public override IEnumerable<PlayableBinding> outputs { get; }
    Property Value
    Type Description
    IEnumerable<PlayableBinding>
    Overrides
    PlayableAsset.outputs

    position

    The translational offset of the clip

    Declaration
    public Vector3 position { get; set; }
    Property Value
    Type Description
    Vector3

    removeStartOffset

    Whether to make the animation clip play relative to its first keyframe.

    Declaration
    public bool removeStartOffset { get; set; }
    Property Value
    Type Description
    bool
    Remarks

    This option only applies to animation clips that animate Transform components.

    rotation

    The rotational offset of the clip, expressed as a Quaternion

    Declaration
    public Quaternion rotation { get; set; }
    Property Value
    Type Description
    Quaternion

    useTrackMatchFields

    Specifies whether to use offset matching options as defined by the track.

    Declaration
    public bool useTrackMatchFields { get; set; }
    Property Value
    Type Description
    bool

    Methods

    CreatePlayable(PlayableGraph, GameObject)

    Creates the root of a Playable subgraph to play the animation clip.

    Declaration
    public override Playable CreatePlayable(PlayableGraph graph, GameObject go)
    Parameters
    Type Name Description
    PlayableGraph graph

    PlayableGraph that will own the playable

    GameObject go

    The gameobject that triggered the graph build

    Returns
    Type Description
    Playable

    The root playable of the subgraph

    Overrides
    PlayableAsset.CreatePlayable(PlayableGraph, GameObject)

    GatherProperties(PlayableDirector, IPropertyCollector)

    Called by the Timeline Editor to gather properties requiring preview.

    Declaration
    public void GatherProperties(PlayableDirector director, IPropertyCollector driver)
    Parameters
    Type Name Description
    PlayableDirector director

    The PlayableDirector invoking the preview

    IPropertyCollector driver

    PropertyCollector used to gather previewable properties

    LiveLink()

    Declaration
    public void LiveLink()

    ResetOffsets()

    Resets the offsets to default values

    Declaration
    public void ResetOffsets()

    Implements

    IPlayableAsset
    ITimelineClipAsset
    IPropertyPreview
    ISerializationCallbackReceiver
    In This Article
    Back to top
    Copyright © 2025 Unity Technologies — Trademarks and terms of use
    • Legal
    • Privacy Policy
    • Cookie Policy
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)