Playables are customizable runtime objects that can be connected together in a tree to create complex behaviours.
Playables can be used to create complex and flexible data evaluation trees. They can be connected together (via Playable.Connect), after which each Playable in the tree can set the "weight" or "influence" of each of its children. Once a tree of Playable is created, it can be "played" by using it with a DirectorPlayer component. (see DirectorPlayer.Play)
Once a Playable (or tree of Playable) is associated with a DirectorPlayer, the player will traverse the Playables one by one. Each time it encounters a Playable in the tree, it will call its PrepareFrame method. This allows the Playable to "prepare itself for the next evaluation". It is during the PrepareFrame stage that each Playable can modify its children (either by adding new inputs or by removing some of them). This enables Playable to "spawn" new children branches in the Playable tree at runtime. This means that Playable trees are not static structures. They can adapt and change over time.
AnimationPlayables are a good example usage of the Playables. They allow existing AnimationClips to be connected together via AnimationPlayableMixers, on the fly. This can be used to programatically create animation behaviours such as locomotion blendtrees. Once a tree of AnimationPlayables is created, it can be passed to an Animator component via the Animator.Play method.
| inputCount | The count of inputs on the Playable. This count includes slots that aren't connected to anything. This is equivalent to, but much faster than calling GetInputs().Length. |
| outputCount | The count of inputs on the Playable. This count includes slots that aren't connected to anything. This is equivalent to, but much faster than calling GetOutputs().Length. |
| state | Current PlayState of this playable. This indicates whether the Playable is currently playing or paused. |
| time | Current local time for this Playable. |
| ClearInputs | Safely disconnects all connected inputs and resizes the input array to 0. |
| Dispose | Implements IDisposable. Call this method to release the resources allocated by the Playable. |
| GetInput | Returns the Playable connected at the specified index. |
| GetInputs | Returns a lists of the input Playables. |
| GetInputWeight | Get the weight of the Playable at a specified index. |
| GetOutput | Returns the Playable connected at the specified output index. |
| GetOutputs | Get the list of ouputs connected on this Playable. |
| ProcessFrame | Evaluates the Playable with a delta time. |
| SetInputWeight | Set the weight of an input. |
| Connect | Connects two Playables together. |
| Disconnect | Disconnects an input from a Playable. |
| OnSetPlayState | Callback called when the PlayState has changed |
| OnSetTime | Callback called when the current time has changed |
| PrepareFrame | Prepares the Playable tree for the next frame. PrepareFrame is called before the tree is evaluated. |