Class TimeControlPlayable

A PlayableBehaviour that manages a component that implements the ITimeControl interface

Inheritance

Object

PlayableBehaviour

TimeControlPlayable

Inherited Members

PlayableBehaviour.OnGraphStart(Playable)

PlayableBehaviour.OnGraphStop(Playable)

PlayableBehaviour.OnPlayableCreate(Playable)

PlayableBehaviour.OnPlayableDestroy(Playable)

PlayableBehaviour.OnBehaviourDelay(Playable, FrameData)

PlayableBehaviour.PrepareData(Playable, FrameData)

PlayableBehaviour.ProcessFrame(Playable, FrameData, Object)

UnityEngine.Playables.PlayableBehaviour.Clone()

Namespace: UnityEngine.Timeline

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

Returns

Type	Description
ScriptPlayable<TimeControlPlayable>

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

PlayableBehaviour.OnBehaviourPause(Playable, FrameData)

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

PlayableBehaviour.OnBehaviourPlay(Playable, FrameData)

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

PlayableBehaviour.PrepareFrame(Playable, FrameData)