LanguageEnglish
  • C#
Experimental: this API is experimental and might be changed or removed in the future.

AnimatorJobExtensions.BindCustomStreamProperty

Leave feedback
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 static Experimental.Animations.PropertyStreamHandle BindCustomStreamProperty(Animator animator, string property, Experimental.Animations.CustomStreamPropertyType type);

Parameters

animatorThe Animator instance that calls this method.
nameThe name of the property.
typeThe type of property to create (float, integer or boolean).

Returns

PropertyStreamHandle Returns the PropertyStreamHandle that represents the new binding.

Description

Create a custom property in the AnimationStream to pass extra data to downstream animation jobs in your graph. Custom properties created in the AnimationStream do not exist in the scene.

You can create custom properties in the AnimationStream that do not exist in the scene. This can be useful when you want to communicate extra data to downstream animation jobs in your graph.

Did you find this page useful? Please give it a rating:

Is something described here not working as you expect it to? It might be a Known Issue. Please check with the Issue Tracker at issuetracker.unity3d.com.

Copyright © 2019 Unity Technologies. Publication: 2019.1-002Y. Built: 2019-08-19.
TutorialsCommunity AnswersKnowledge BaseForumsAsset StoreLegalPrivacy PolicyCookiesDo Not Sell or Share My Personal Information