class in UnityEngine.Playables
/
Inherits from:Behaviour
/
Implemented in:UnityEngine.DirectorModule
Implements interfaces:IExposedPropertyTable
Instantiates a PlayableGraph from a PlayableAsset and controls playback of Playable objects.
This API is mainly designed to provide scheduling and scene binding support and scheduling for the Timeline package. Our users may find limited use for it otherwise.
Most of the functionality of this class can be replicated by using PlayableGraph.
| duration | The duration of the currently connected Playable in seconds. |
| extrapolationMode | Controls how the time is incremented when it goes beyond the duration of the playable. |
| initialTime | The time at which the Playable should start when first played. |
| playableAsset | The PlayableAsset that is used to instantiate a playable for playback. |
| playableGraph | The PlayableGraph created by the PlayableDirector. |
| playOnAwake | Whether the playable asset will start playing back as soon as the component awakes. |
| state | The current playing state of the component. (Read Only) |
| time | The component's current time. This value is incremented according to the PlayableDirector.timeUpdateMode when it is playing. You can also change this value manually. |
| timeUpdateMode | Controls how time is incremented when playing back. |
| ClearGenericBinding | Clears the binding of a reference object. |
| ClearReferenceValue | Clears an exposed reference value. |
| DeferredEvaluate | Schedules the PlayableDirector to perform PlayableGraph.Evaluate on the PlayableGraph associated with the PlayableDirector.playableAsset on the next update. |
| Evaluate | Immediately performs PlayableGraph.Evaluate on the PlayableGraph associated with the PlayableDirector.playableAsset at PlayableDirector.time. |
| GetGenericBinding | Returns a binding to a reference object. |
| GetReferenceValue | Retreives an ExposedReference binding. |
| Pause | Pauses playback of the currently running playable. |
| Play | Instatiates a Playable using the provided PlayableAsset and starts playback. |
| RebindPlayableGraphOutputs | Rebinds each PlayableOutput of the PlayableGraph. |
| RebuildGraph | Discards the existing PlayableGraph and creates a new instance. |
| Resume | Resume playing a paused playable. |
| SetGenericBinding | Sets the binding of a reference object from a PlayableBinding. |
| SetReferenceValue | Sets an ExposedReference value. |
| Stop | Stops playback of the current Playable and destroys the corresponding graph. |
| paused | Event that is raised when a PlayableDirector component has paused. |
| played | Event that is raised when a PlayableDirector component has begun playing. |
| stopped | Event that is raised when a PlayableDirector component has stopped. |
| enabled | Enabled Behaviours are Updated, disabled Behaviours are not. |
| isActiveAndEnabled | Reports whether a GameObject and its associated Behaviour is active and enabled. |
| gameObject | The game object this component is attached to. A component is always attached to a game object. |
| tag | The tag of this game object. |
| transform | The Transform attached to this GameObject. |
| hideFlags | Should the object be hidden, saved with the Scene or modifiable by the user? |
| name | The name of the object. |
| BroadcastMessage | Calls the method named methodName on every MonoBehaviour in this game object or any of its children. |
| CompareTag | Checks the GameObject's tag against the defined tag. |
| GetComponent | Gets a reference to a component of type T on the same GameObject as the component specified. |
| GetComponentInChildren | Gets a reference to a component of type T on the same GameObject as the component specified, or any child of the GameObject. |
| GetComponentIndex | Gets the index of the component on its parent GameObject. |
| GetComponentInParent | Gets a reference to a component of type T on the same GameObject as the component specified, or any parent of the GameObject. |
| GetComponents | Gets references to all components of type T on the same GameObject as the component specified. |
| GetComponentsInChildren | Gets references to all components of type T on the same GameObject as the component specified, and any child of the GameObject. |
| GetComponentsInParent | Gets references to all components of type T on the same GameObject as the component specified, and any parent of the GameObject. |
| SendMessage | Calls the method named methodName on every MonoBehaviour in this game object. |
| SendMessageUpwards | Calls the method named methodName on every MonoBehaviour in this game object and on every ancestor of the behaviour. |
| TryGetComponent | Gets the component of the specified type, if it exists. |
| GetInstanceID | Gets the instance ID of the object. |
| ToString | Returns the name of the object. |
| Destroy | Removes a GameObject, component or asset. |
| DestroyImmediate | Destroys the object obj immediately. You are strongly recommended to use Destroy instead. |
| DontDestroyOnLoad | Do not destroy the target Object when loading a new Scene. |
| FindAnyObjectByType | Retrieves any active loaded object of Type type. |
| FindFirstObjectByType | Retrieves the first active loaded object of Type type. |
| FindObjectsByType | Retrieves a list of all loaded objects of Type type. |
| Instantiate | Clones the object original and returns the clone. |
| InstantiateAsync | Captures a snapshot of the original object (that must be related to some GameObject) and returns the AsyncInstantiateOperation. |
| bool | Does 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. |