Version: 2019.2
LanguageEnglish
  • C#

PlayableDirector

class in UnityEngine.Playables

/

Inherits from:Behaviour

/

Implemented in:UnityEngine.DirectorModule


Implements interfaces:IExposedPropertyTable

Suggest a change

Success!

Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.

Close

Submission failed

For some reason your suggested change could not be submitted. Please <a>try again</a> in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

Description

Instantiates a PlayableAsset and controls playback of Playable objects.

Properties

durationThe duration of the Playable in seconds.
extrapolationModeControls how the time is incremented when it goes beyond the duration of the playable.
initialTimeThe time at which the Playable should start when first played.
playableAssetThe PlayableAsset that is used to instantiate a playable for playback.
playableGraphThe PlayableGraph created by the PlayableDirector.
playOnAwakeWhether the playable asset will start playing back as soon as the component awakes.
stateThe current playing state of the component. (Read Only)
timeThe component's current time. This value is incremented according to the PlayableDirector.timeUpdateMode when it is playing. You can also change this value manually.
timeUpdateModeControls how time is incremented when playing back.

Public Methods

ClearGenericBindingClears the binding of a reference object.
ClearReferenceValueClears an exposed reference value.
DeferredEvaluateTells the PlayableDirector to evaluate it's PlayableGraph on the next update.
EvaluateEvaluates the currently playing Playable at the current time.
GetGenericBindingReturns a binding to a reference object.
GetReferenceValueRetreives an ExposedReference binding.
PausePauses playback of the currently running playable.
PlayInstatiates a Playable using the provided PlayableAsset and starts playback.
RebindPlayableGraphOutputsRebinds each PlayableOutput of the PlayableGraph.
RebuildGraphDiscards the existing PlayableGraph and creates a new instance.
ResumeResume playing a paused playable.
SetGenericBindingSets the binding of a reference object from a PlayableBinding.
SetReferenceValueSets an ExposedReference value.
StopStops playback of the current Playable and destroys the corresponding graph.

Events

pausedEvent that is raised when a PlayableDirector component has paused.
playedEvent that is raised when a PlayableDirector component has begun playing.
stoppedEvent that is raised when a PlayableDirector component has stopped.

Inherited Members

Properties

enabledEnabled Behaviours are Updated, disabled Behaviours are not.
isActiveAndEnabledHas the Behaviour had active and enabled called?
gameObjectThe game object this component is attached to. A component is always attached to a game object.
tagThe tag of this game object.
transformThe Transform attached to this GameObject.
hideFlagsShould the object be hidden, saved with the Scene or modifiable by the user?
nameThe name of the object.

Public Methods

BroadcastMessageCalls the method named methodName on every MonoBehaviour in this game object or any of its children.
CompareTagIs this game object tagged with tag ?
GetComponentReturns the component of Type type if the game object has one attached, null if it doesn't.
GetComponentInChildrenReturns the component of Type type in the GameObject or any of its children using depth first search.
GetComponentInParentReturns the component of Type type in the GameObject or any of its parents.
GetComponentsReturns all components of Type type in the GameObject.
GetComponentsInChildrenReturns all components of Type type in the GameObject or any of its children.
GetComponentsInParentReturns all components of Type type in the GameObject or any of its parents.
SendMessageCalls the method named methodName on every MonoBehaviour in this game object.
SendMessageUpwardsCalls the method named methodName on every MonoBehaviour in this game object and on every ancestor of the behaviour.
TryGetComponentGets the component of the specified type, if it exists.
GetInstanceIDReturns the instance id of the object.
ToStringReturns the name of the object.

Static Methods

DestroyRemoves a GameObject, component or asset.
DestroyImmediateDestroys the object obj immediately. You are strongly recommended to use Destroy instead.
DontDestroyOnLoadDo not destroy the target Object when loading a new Scene.
FindObjectOfTypeReturns the first active loaded object of Type type.
FindObjectsOfTypeReturns a list of all active loaded objects of Type type.
InstantiateClones the object original and returns the clone.

Operators

boolDoes the object exist?
operator !=Compares if two objects refer to a different object.
operator ==Compares two object references to see if they refer to the same object.

Did you find this page useful? Please give it a rating: