Class TimelinePlayable

The root Playable generated by timeline.

Inheritance

Object

PlayableBehaviour

TimelinePlayable

Inherited Members

PlayableBehaviour.OnGraphStart(Playable)

PlayableBehaviour.OnGraphStop(Playable)

PlayableBehaviour.OnPlayableCreate(Playable)

PlayableBehaviour.OnPlayableDestroy(Playable)

PlayableBehaviour.OnBehaviourDelay(Playable, FrameData)

PlayableBehaviour.OnBehaviourPlay(Playable, FrameData)

PlayableBehaviour.OnBehaviourPause(Playable, FrameData)

PlayableBehaviour.PrepareData(Playable, FrameData)

PlayableBehaviour.ProcessFrame(Playable, FrameData, Object)

UnityEngine.Playables.PlayableBehaviour.Clone()

Namespace: UnityEngine.Timeline

Syntax

public class TimelinePlayable : PlayableBehaviour, IPlayableBehaviour, ICloneable

Methods

Compile(PlayableGraph, Playable, IEnumerable<TrackAsset>, GameObject, Boolean, Boolean)

Compiles the subgraph of this timeline

Declaration

public void Compile(PlayableGraph graph, Playable timelinePlayable, IEnumerable<TrackAsset> tracks, GameObject go, bool autoRebalance, bool createOutputs)

Parameters

Type	Name	Description
PlayableGraph	graph	The playable graph to inject the timeline.
Playable	timelinePlayable
IEnumerable<TrackAsset>	tracks	The list of tracks to compile
GameObject	go	The GameObject that initiated the compilation
Boolean	autoRebalance	In the editor, whether the graph should account for the possibility of changing clip times
Boolean	createOutputs	Whether to create PlayableOutputs in the graph

Create(PlayableGraph, IEnumerable<TrackAsset>, GameObject, Boolean, Boolean)

Creates an instance of a Timeline

Declaration

public static ScriptPlayable<TimelinePlayable> Create(PlayableGraph graph, IEnumerable<TrackAsset> tracks, GameObject go, bool autoRebalance, bool createOutputs)

Parameters

Type	Name	Description
PlayableGraph	graph	The playable graph to inject the timeline.
IEnumerable<TrackAsset>	tracks	The list of tracks to compile
GameObject	go	The GameObject that initiated the compilation
Boolean	autoRebalance	In the editor, whether the graph should account for the possibility of changing clip times
Boolean	createOutputs	Whether to create PlayableOutputs in the graph

Returns

Type	Description
ScriptPlayable<TimelinePlayable>	A subgraph with the playable containing a TimelinePlayable behaviour as the root

PrepareFrame(Playable, FrameData)

Overridden to handle synchronizing time on the timeline instance.

Declaration

public override void PrepareFrame(Playable playable, FrameData info)

Parameters

Type	Name	Description
Playable	playable	The Playable that owns the current PlayableBehaviour.
FrameData	info	A FrameData structure that contains information about the current frame context.

Overrides

PlayableBehaviour.PrepareFrame(Playable, FrameData)