Version: 5.6 (switch to 2017.1b)
LanguageEnglish
  • C#
  • JS

Script language

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

GameObject.AddComponent

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

Switch to Manual
Obsolete public function AddComponent(className: string): Component;
Obsolete public Component AddComponent(string className);

Description

Adds a component class named className to the game object.

Use this function to change behaviour of objects on the fly. You can also add script to game objects by passing in the name of the script class.

Some components require other components to exist in the same game object as well. This function automatically adds any required components as well eg. if you add a HingeJoint this will automatically add a Rigidbody as well.

#pragma strict
public class AddComponentExample extends MonoBehaviour {
	function Start() {
		var sc: SphereCollider = gameObject.AddComponent("SphereCollider") as SphereCollider;
	}
}
using UnityEngine;
using System.Collections;

public class AddComponentExample : MonoBehaviour { void Start() { SphereCollider sc = gameObject.AddComponent("SphereCollider") as SphereCollider; } }

public function AddComponent(componentType: Type): Component;
public Component AddComponent(Type componentType);

Description

Adds a component class of type componentType to the game object. C# Users can use a generic version.

#pragma strict
public class AddComponentExample extends MonoBehaviour {
	function Start() {
		var sc: SphereCollider = gameObject.AddComponent(SphereCollider) as SphereCollider;
	}
}
using UnityEngine;
using System.Collections;

public class AddComponentExample : MonoBehaviour { void Start() { SphereCollider sc = gameObject.AddComponent(typeof(SphereCollider)) as SphereCollider; } }

Note that there is no RemoveComponent(), to remove a component, use Object.Destroy.


public function AddComponent(): T;
public T AddComponent();

Description

Generic version. See the Generic Functions page for more details.

#pragma strict
public class AddComponentExample extends MonoBehaviour {
	function Start() {
		var sc: SphereCollider = gameObject.AddComponent.<SphereCollider>() as SphereCollider;
	}
}
using UnityEngine;
using System.Collections;

public class AddComponentExample : MonoBehaviour { void Start() { SphereCollider sc = gameObject.AddComponent<SphereCollider>() as SphereCollider; } }