Version: 2022.1
LanguageEnglish
  • C#

AnimatorJobExtensions.BindSceneProperty

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

Declaration

public static Animations.PropertySceneHandle BindSceneProperty(Animator animator, Transform transform, Type type, string property);

Declaration

public static Animations.PropertySceneHandle BindSceneProperty(Animator animator, Transform transform, Type type, string property, bool isObjectReference = false);

Parameters

animator The Animator instance that calls this method.
transform The Transform to target.
type The Component type.
property The property to bind.
isObjectReference isObjectReference need to be set to true if the property to bind does access an Object like SpriteRenderer.sprite.

Returns

PropertySceneHandle Returns the PropertySceneHandle that represents the new binding.

Description

Create a PropertySceneHandle representing the new binding on the Component property of a Transform in the Scene.

You can bind a property that doesn't exist yet. For example you can bind a property on a MonoBehaviour that will be added later dynamically. In this case, you need to manually resolve the handle after adding the MonoBehaviour on the GameObject, using ResolveAllSceneHandles.