Legacy Documentation: Version 5.3
LanguageEnglish
  • C#
  • JS

Script language

Select your preferred scripting language. All code snippets will be displayed in this language.

AnimationPlayable

class in UnityEngine.Experimental.Director

/

Inherits from: Experimental.Director.Playable

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

Sumbission failed

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

Close

Cancel

Description

Base class for all animation related Playable classes.

Public Functions

AddInputAdds an AnimationPlayable as an input.
RemoveAllInputsDisconnects all input playables.
RemoveInputRemoves a playable from the list of inputs.
SetInputSets an AnimationPlayable as an input.
SetInputsReplaces existing inputs with the supplied collection of AnimationPlayable.

Inherited members

Variables

inputCountThe 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.
outputCountThe 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.
stateCurrent PlayState of this playable. This indicates whether the Playable is currently playing or paused.
timeCurrent local time for this Playable.

Public Functions

ClearInputsSafely disconnects all connected inputs and resizes the input array to 0.
DisposeImplements IDisposable. Call this method to release the resources allocated by the Playable.
GetInputReturns the Playable connected at the specified index.
GetInputsReturns a lists of the input Playables.
GetInputWeightGet the weight of the Playable at a specified index.
GetOutputReturns the Playable connected at the specified output index.
GetOutputsGet the list of ouputs connected on this Playable.
ProcessFrameEvaluates the Playable with a delta time.
SetInputWeightSet the weight of an input.

Static Functions

ConnectConnects two Playables together.
DisconnectDisconnects an input from a Playable.

Messages

OnSetPlayStateCallback called when the PlayState has changed
OnSetTimeCallback called when the current time has changed
PrepareFramePrepares the Playable tree for the next frame. PrepareFrame is called before the tree is evaluated.