Class TimeControlPlayable

A PlayableBehaviour that manages a component that implements the ITimeControl interface

Inheritance
object
PlayableBehaviour
TimeControlPlayable
Implements
Inherited Members
PlayableBehaviour.Clone()
Namespace: UnityEngine.Timeline
Assembly: Unity.Timeline.dll
Syntax
public class TimeControlPlayable : PlayableBehaviour, IPlayableBehaviour, ICloneable

Methods

Create(PlayableGraph, ITimeControl)

Creates a Playable with a TimeControlPlayable behaviour attached

Declaration
public static ScriptPlayable<TimeControlPlayable> Create(PlayableGraph graph, ITimeControl timeControl)
Parameters
Type Name Description
PlayableGraph graph

The PlayableGraph to inject the Playable into.
ITimeControl timeControl

Component that implements the ITimeControl interface.
Returns
Type Description
ScriptPlayable<TimeControlPlayable>

The playable created

Initialize(ITimeControl)

Initializes the behaviour

Declaration
public void Initialize(ITimeControl timeControl)
Parameters
Type Name Description
ITimeControl timeControl

Component that implements the ITimeControl interface

OnBehaviourPause(Playable, FrameData)

This function is called when the Playable play state is changed to PlayState.Paused.

Declaration
public override void OnBehaviourPause(Playable playable, FrameData info)
Parameters
Type Name Description
Playable playable

The playable this behaviour is attached to.
FrameData info

A FrameData structure that contains information about the current frame context.
Overrides

OnBehaviourPlay(Playable, FrameData)

This function is called when the Playable play state is changed to Playables.PlayState.Playing.

Declaration
public override void OnBehaviourPlay(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

PrepareFrame(Playable, FrameData)

This function is called during the PrepareFrame phase of the PlayableGraph.

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

Implements