Legacy Documentation: Version 2017.1 (Go to current version)
LanguageEnglish
  • C#
  • JS

Script language

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

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

GameObjectRecorder.BindComponent

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 BindComponent(target: GameObject, recursive: bool): void;
public void BindComponent(GameObject target, bool recursive);
public function BindComponent(target: GameObject, componentType: Type, recursive: bool): void;
public void BindComponent(GameObject target, Type componentType, bool recursive);

Parameters

target root or any of its children.
recursive Binds also the target's children transform properties when set to true.
componentType Type of the component.

Description

Adds bindings for all the properties of the first component of type T found in target, and also for all the target's children if recursive is true.

#pragma strict
public class BindComponentScript extends MonoBehaviour {
	function Start() {
		var recorder: var = new GameObjectRecorder();
		recorder.root = gameObject;
		// Add bindings for all the properties of the Transform and BoxCollider components.
		recorder.BindComponent.<Transform>(gameObject, false);
		recorder.BindComponent.<BoxCollider>(gameObject, false);
	}
}
using UnityEngine;
using UnityEditor;
using UnityEditor.Experimental.Animations;

public class BindComponentScript : MonoBehaviour { void Start() { var recorder = new GameObjectRecorder(); recorder.root = gameObject;

// Add bindings for all the properties of the Transform and BoxCollider components. recorder.BindComponent<Transform>(gameObject, false); recorder.BindComponent<BoxCollider>(gameObject, false); } }

It is also possible to use the non-generic method, in which case typeof() will get the Type of the component.

This example gets exactly the same result as the example above:

#pragma strict
public class BindComponentNonGenericScript extends MonoBehaviour {
	function Start() {
		var recorder: var = new GameObjectRecorder();
		recorder.root = gameObject;
		recorder.BindComponent(gameObject, Transform, false);
		recorder.BindComponent(gameObject, BoxCollider, false);
	}
}
using UnityEngine;
using UnityEditor;
using UnityEditor.Experimental.Animations;

public class BindComponentNonGenericScript : MonoBehaviour { void Start() { var recorder = new GameObjectRecorder(); recorder.root = gameObject;

recorder.BindComponent(gameObject, typeof(Transform), false); recorder.BindComponent(gameObject, typeof(BoxCollider), false); } }

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