Legacy Documentation: Version 5.4
LanguageEnglish
  • C#
  • JS

Script language

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

AnimationPlayable

struct in UnityEngine.Experimental.Director

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.

Static Variables

NullA Null AnimationPlayable used to create empty input connections.

Variables

durationDuration in seconds.
inputCountThe count of inputs on the Playable. This count includes slots that aren't connected to anything.
outputCountThe count of ouputs on the Playable. Currently only 1 output is supported.
stateCurrent PlayState of this playable. This indicates whether the Playable is currently playing or paused.
timeCurrent time in seconds.

Public Functions

AddInputAdds an Playable as an input.
CastToYou can use the CastTo operator to perform certain types of conversions between compatible reference types or nullable types.
DestroyCall this method to release the resources allocated by the Playable.
GetInputReturns the Playable connected at the specified index.
GetInputWeightGet the weight of the Playable at a specified index.
GetOutputReturns the Playable connected at the specified output index.
IsValidReturns true if the Playable is valid. A playable can be invalid if it was disposed. This is different from a Null playable..
RemoveAllInputsDisconnects all input playables.
RemoveInputRemoves a playable from the list of inputs.
SetInputSets an Playable as an input.
SetInputsReplaces existing inputs with the supplied collection of Playable.
SetInputWeightSet the weight of an input.