PlayableDirector

Description

Controls playback of Playable objects.

The PlayableDirector is primarily used by the Timeline Package to handle bindings to scene objects and control playback of the PlayableGraph.
The PlayableDirector object builds a PlayableGraph from a PlayableAsset. Once the graph is built, use the PlayableDirector to manage playback of the graph's Playable. To control playback of the PlayableGraph, use:

• PlayableDirector.Play
• PlayableDirector.Stop
• PlayableDirector.Pause
• PlayableDirector.Resume

To be notified of playback state changes, subscribe to:

• PlayableDirector.played
• PlayableDirector.paused
• PlayableDirector.stopped

To handle references between assets and scene objects, PlayableDirector implements IExposedPropertyTable. To set or get bindings, use:

• PlayableDirector.SetGenericBinding
• PlayableDirector.GetGenericBinding

Multiple PlayableDirectors can reference the same PlayableAsset. When this occurs, each PlayableDirector creates its own independent PlayableGraph with its own scene bindings.

The following example demonstrates how to use the Playable Director to bind scene objects to assets and how to control the Playable Graph.

using System;
using UnityEngine;
using UnityEngine.Playables;
using Object = UnityEngine.Object;

[RequireComponent(typeof(PlayableDirector))]
public class PlayableDirectorSample : MonoBehaviour
{
    PlayableDirector m_Director;
    TestPlayableAsset m_TestAsset;

    void Start()
    {
        m_Director = gameObject.GetComponent<PlayableDirector>();
        m_TestAsset = ScriptableObject.CreateInstance<TestPlayableAsset>();
        m_Director.playableAsset = m_TestAsset;
        m_Director.SetGenericBinding(m_TestAsset, gameObject);
        BuildGraphAndPlay();
    }

    void BuildGraphAndPlay()
    {
        m_Director.RebuildGraph();
        if (m_Director.playableGraph.IsValid())
        {
            m_Director.Play();
        }
    }
}

[Serializable]
class TestBehaviour : PlayableBehaviour
{
    public override void OnPlayableCreate(Playable playable) { }

    public override void OnPlayableDestroy(Playable playable) { }
    public Object target { get; set; }
    public override void OnBehaviourPlay(Playable playable, FrameData info)
    {
        base.OnBehaviourPlay(playable, info);
        if (target != null)
        {
            Debug.Log($"{target.name}-{info.frameId}");
        }
    }
}

[Serializable]
class TestPlayableAsset : PlayableAsset
{
    public override Playable CreatePlayable(PlayableGraph graph, GameObject owner)
    {
        ScriptPlayable<TestBehaviour> behavior = ScriptPlayable<TestBehaviour>.Create(graph);
        var director = owner.GetComponent<PlayableDirector>();
        Object target = director.GetGenericBinding(this);
        behavior.GetBehaviour().target = target;
        return behavior;
    }
}

Properties

Public Methods

Events

Inherited Members