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

Object

ScriptableObject

PlayableAsset

TrackAsset

StoryboardTrack

Implements

IPlayableAsset

ISerializationCallbackReceiver

IPropertyPreview

Inherited Members

TrackAsset.OnBeforeTrackSerialize()

TrackAsset.OnAfterTrackDeserialize()

TrackAsset.m_Clips

TrackAsset.start

TrackAsset.end

TrackAsset.duration

TrackAsset.muted

TrackAsset.mutedInHierarchy

TrackAsset.timelineAsset

TrackAsset.parent

TrackAsset.GetClips()

TrackAsset.isEmpty

TrackAsset.hasClips

TrackAsset.hasCurves

TrackAsset.isSubTrack

TrackAsset.outputs

TrackAsset.GetChildTracks()

TrackAsset.curves

TrackAsset.locked

TrackAsset.lockedInHierarchy

TrackAsset.supportsNotifications

TrackAsset.CreateCurves(string)

TrackAsset.CreatePlayable(PlayableGraph, GameObject)

TrackAsset.CreateDefaultClip()

TrackAsset.CreateClip<T>()

TrackAsset.DeleteClip(TimelineClip)

TrackAsset.CreateMarker(Type, double)

TrackAsset.CreateMarker<T>(double)

TrackAsset.DeleteMarker(IMarker)

TrackAsset.GetMarkers()

TrackAsset.GetMarkerCount()

TrackAsset.GetMarker(int)

TrackAsset.GatherProperties(PlayableDirector, IPropertyCollector)

TrackAsset.CalculateItemsHash()

TrackAsset.CreatePlayable(PlayableGraph, GameObject, TimelineClip)

TrackAsset.CanCreateTrackMixer()

TrackAsset.GetAnimationClipHash(AnimationClip)

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.DontDestroyOnLoad(Object)

Object.DestroyObject(Object, float)

Object.DestroyObject(Object)

Object.FindSceneObjectsOfType(Type)

Object.FindObjectsOfTypeIncludingAssets(Type)

Object.FindObjectsOfType<T>()

Object.FindObjectsOfType<T>(bool)

Object.FindObjectOfType<T>()

Object.FindObjectOfType<T>(bool)

Object.FindObjectsOfTypeAll(Type)

Object.FindObjectOfType(Type)

Object.FindObjectOfType(Type, bool)

Object.ToString()

Object.name

Object.hideFlags

object.Equals(object, object)

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

Namespace: UnityEngine.Sequences.Timeline

Assembly: Unity.Sequences.dll

Syntax

[Serializable]
[TrackClipType(typeof(StoryboardPlayableAsset))]
[TrackColor(0.92941177, 0.49411765, 0.007843138)]
public class StoryboardTrack : TrackAsset, IPlayableAsset, ISerializationCallbackReceiver, IPropertyPreview

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

[Tooltip("Clips created in this track will be created with this default duration.Changing this value with not change the length of pre-existing Clips")]
[SerializeField]
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 sortingOrder value.

Declaration

[Tooltip("sorting order of the Storyboard Canvas")]
[SerializeField]
public int sortOrder

Field Value

Type	Description
int

Methods

CreateTrackMixer(PlayableGraph, GameObject, int)

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.
int	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.

Overrides

TrackAsset.CreateTrackMixer(PlayableGraph, GameObject, int)

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

Overrides

UnityEngine.Timeline.TrackAsset.OnCreateClip(UnityEngine.Timeline.TimelineClip)

Implements

IPlayableAsset

ISerializationCallbackReceiver

UnityEngine.Timeline.IPropertyPreview