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

AnimatorJobExtensions.BindCustomStreamProperty

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: