Documentation

Unity Engine


User Manual

Script Reference

Unity Engine


BindCustomStreamProperty(Animator, string, CustomStreamPropertyType)

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.
Read time 1 minuteLast updated 12 days ago

Definition

public static PropertyStreamHandle BindCustomStreamProperty(this Animator animator, string property, CustomStreamPropertyType type)

Parameters

animator

The Animator instance that calls this method.

property


The type of property to create (float, integer or boolean).

Returns

Type

Description

PropertyStreamHandleReturns the PropertyStreamHandle that represents the new binding.

Remarks

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.