Version: 2021.2
LanguageEnglish
  • C#

AnimationScriptPlayable

struct in UnityEngine.Animations

/

Implemented in:UnityEngine.AnimationModule


Implements interfaces:IAnimationJobPlayable, IPlayable

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

A Playable that can run a custom, multi-threaded animation job.

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.

See Also: IAnimationJob, and AnimationScriptPlayable.Create.

Public Methods

GetJobDataGets the job data contained in the playable.
GetProcessInputsReturns whether the playable inputs will be processed or not.
SetJobDataSets a new job data in the playable.
SetProcessInputsSets the new value for processing the inputs or not.

Static Methods

CreateCreates an AnimationScriptPlayable in the PlayableGraph.