Version: 5.5 (switch to 5.6b)
LanguageEnglish
  • C#
  • JS

Script language

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

AnimationPlayable.CastTo

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

public function CastTo(): T;
public T CastTo();

Returns

T Returns the Playable casted to the type specified, throws InvalidCastException if the cast failed.

Description

You can use the CastTo operator to perform certain types of conversions between compatible reference types or nullable types.

Some Playables are implemented as internal C++ objects but are exposed as C# structs. This is to allow the possibility of creating Playable graphs without allocating GC memory in your C# scripts. One down side of using structs as opposed to classes, is that struct in C# do not support inheritance. The CastTo method allows you to convert a C# Playable into one of it's "derived C++ class".