Version: 5.4 beta (switch to 5.3)
LanguageEnglish
  • C#
  • JS

Script language

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

CustomAnimationPlayable

class in UnityEngine.Experimental.Director

/

Inherits from: Experimental.Director.ScriptPlayable

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

To implement custom handling of AnimationPlayable, inherit from this class.

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 associated to this 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.
OnSetPlayStateOverride this method to perform custom operations when the PlayState changes.
OnSetTimeOverride this method to perform custom operations when the local time changes.
PrepareFrameOverride this method to manage input connections and change weights on inputs.
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.

Inherited members