AnimationScriptPlayable
A Playable that can run a custom, multi-threaded animation job.
Read time 1 minuteLast updated 5 days ago
Definition
- Type: Struct
- Namespace: UnityEngine.Animations
- Assembly: UnityEngine.AnimationModule
- Implements: IAnimationJobPlayable, IPlayable, IEquatable<AnimationScriptPlayable>
public struct AnimationScriptPlayable : IAnimationJobPlayable, IPlayable, IEquatable<AnimationScriptPlayable>
Remarks
This playable allows to create a custom C# job that will give read and write access to the AnimationStream during the animation process pass in the PlayableGraph. The C# job must implement the interface IAnimationJob.
NOTE: You can use PlayableExtensions methods with AnimationScriptPlayable objects.
Additional Resources: IAnimationJob, and AnimationScriptPlayable.Create.
Methods
Method | Description |
|---|---|
| GetJobData | Gets the job data contained in the playable. |
| GetProcessInputs | Returns whether the playable inputs will be processed or not. |
| SetJobData | Sets a new job data in the playable. |
| SetProcessInputs | Sets the new value for processing the inputs or not. |
Static Methods
Method | Description |
|---|---|
| Create | Creates an AnimationScriptPlayable in the PlayableGraph. |
Operators
Operator | Description |
|---|---|
| Playable | Operator to down-cast an AnimationScriptPlayable to a Playable. |