Class DirectorControlPlayable

Playable Behaviour used to control a PlayableDirector.

Inheritance

Object

PlayableBehaviour

DirectorControlPlayable

Inherited Members

PlayableBehaviour.OnGraphStart(Playable)

PlayableBehaviour.OnGraphStop(Playable)

PlayableBehaviour.OnPlayableCreate(Playable)

PlayableBehaviour.OnBehaviourDelay(Playable, FrameData)

PlayableBehaviour.PrepareData(Playable, FrameData)

UnityEngine.Playables.PlayableBehaviour.Clone()

Namespace: UnityEngine.Timeline

Syntax

public class DirectorControlPlayable : PlayableBehaviour, IPlayableBehaviour, ICloneable

Remarks

This playable is used to control other PlayableDirector components from a Timeline sequence.

Fields

director

The PlayableDirector being controlled by this PlayableBehaviour

Declaration

public PlayableDirector director

Field Value

Type	Description
PlayableDirector

Methods

Create(PlayableGraph, PlayableDirector)

Creates a Playable with a DirectorControlPlayable attached

Declaration

public static ScriptPlayable<DirectorControlPlayable> Create(PlayableGraph graph, PlayableDirector director)

Parameters

Type	Name	Description
PlayableGraph	graph	The graph to inject the playable into
PlayableDirector	director	The director to control

Returns

Type	Description
ScriptPlayable<DirectorControlPlayable>	Returns a Playable with a DirectorControlPlayable attached

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)

OnPlayableDestroy(Playable)

Declaration

public override void OnPlayableDestroy(Playable playable)

Parameters

Type	Name	Description
Playable	playable

Overrides

PlayableBehaviour.OnPlayableDestroy(Playable)

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)

ProcessFrame(Playable, FrameData, Object)

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

Declaration

public override void ProcessFrame(Playable playable, FrameData info, object playerData)

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.
Object	playerData	unused

Overrides

PlayableBehaviour.ProcessFrame(Playable, FrameData, Object)