docs.unity3d.com
Search Results for

    Show / Hide Table of Contents

    Class DirectorControlPlayable

    Playable Behaviour used to control a PlayableDirector.

    Inheritance
    object
    PlayableBehaviour
    DirectorControlPlayable
    Implements
    IPlayableBehaviour
    ICloneable
    Inherited Members
    PlayableBehaviour.OnGraphStart(Playable)
    PlayableBehaviour.OnGraphStop(Playable)
    PlayableBehaviour.OnPlayableCreate(Playable)
    PlayableBehaviour.OnBehaviourDelay(Playable, FrameData)
    PlayableBehaviour.PrepareData(Playable, FrameData)
    PlayableBehaviour.Clone()
    object.Equals(object)
    object.Equals(object, object)
    object.GetHashCode()
    object.GetType()
    object.MemberwiseClone()
    object.ReferenceEquals(object, object)
    object.ToString()
    Namespace: UnityEngine.Timeline
    Assembly: Unity.Timeline.dll
    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

    pauseAction

    Sets the action to perform when the playable is paused. DirectorControlPlayable.PauseAction

    Declaration
    public DirectorControlPlayable.PauseAction pauseAction
    Field Value
    Type Description
    DirectorControlPlayable.PauseAction

    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)

    This function is called when this PlayableBehaviour is destroyed.

    Declaration
    public override void OnPlayableDestroy(Playable playable)
    Parameters
    Type Name Description
    Playable playable

    The Playable that owns the current PlayableBehaviour.

    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)

    Implements

    IPlayableBehaviour
    ICloneable
    In This Article
    Back to top
    Copyright © 2025 Unity Technologies — Trademarks and terms of use
    • Legal
    • Privacy Policy
    • Cookie Policy
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)