docs.unity3d.com
    Show / Hide Table of Contents

    Class StoryboardTrack

    The StoryboardTrack supports StoryboardPlayableAsset in order to create a Storyboard in Timeline. This allows users to iterate on their cinematic timing and have a base for blocking in Unity.

    Inheritance
    Object
    StoryboardTrack
    Namespace: UnityEngine.Sequences.Timeline
    Syntax
    public class StoryboardTrack : TrackAsset

    Fields

    defaultFrameDuration

    This is the default duration of each newly created clip on the Storyboard track. By default it is set to 3 seconds, which means that every new Storyboard image added via a new clip on the track will last for 3 seconds.

    Declaration
    public double defaultFrameDuration
    Field Value
    Type Description
    Double
    Remarks

    Changing this value does not affect the duration of existing clips.

    sortOrder

    The StoryboardTrack uses Canvas to display the different Storyboard frames. Use this parameter to control the value.

    Declaration
    public int sortOrder
    Field Value
    Type Description
    Int32

    Methods

    CreateTrackMixer(PlayableGraph, GameObject, Int32)

    Creates a mixer used to blend playables generated by clips on the track.

    Declaration
    public override Playable CreateTrackMixer(PlayableGraph graph, GameObject go, int inputCount)
    Parameters
    Type Name Description
    PlayableGraph graph

    The graph to inject playables into.

    GameObject go

    The GameObject that requested the graph.

    Int32 inputCount

    The number of playables from clips that will be inputs to the returned mixer.

    Returns
    Type Description
    Playable

    A handle to the Playable node representing the mixer.

    OnCreateClip(TimelineClip)

    Called when a clip is created on a track.

    Declaration
    protected override void OnCreateClip(TimelineClip clip)
    Parameters
    Type Name Description
    TimelineClip clip

    The timeline clip added to this track

    Back to top
    Terms of use
    Copyright © 2023 Unity Technologies — Terms of use
    • Legal
    • Privacy Policy
    • Cookies
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)
    "Unity", Unity logos, and other Unity trademarks are trademarks or registered trademarks of Unity Technologies or its affiliates in the U.S. and elsewhere (more info here). Other names or brands are trademarks of their respective owners.
    Generated by DocFX on 18 October 2023