Legacy Documentation: Version 4.6(go to latest)
Language: English
  • C#
  • JS
  • Boo

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

Sumbission failed

For some reason your suggested change could not be submitted. Please try again in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

public function AddComponent(className: string): Component;
public Component AddComponent(string className);
public def AddComponent(className as string) as Component

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.

	// Adds the sphere collider to the game object
	var sc : SphereCollider;
	sc = gameObject.AddComponent ("SphereCollider");
using UnityEngine;
using System.Collections;

public class ExampleClass : MonoBehaviour {
    public SphereCollider sc;
    void Example() {
        sc = gameObject.AddComponent("SphereCollider") as SphereCollider;
    }
}
import UnityEngine
import System.Collections

public class ExampleClass(MonoBehaviour):

	public sc as SphereCollider

	def Example() as void:
		sc = (gameObject.AddComponent('SphereCollider') as SphereCollider)

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

Description

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

	// Adds the sphere collider to the game object
	var sc : SphereCollider;
	sc = gameObject.AddComponent (SphereCollider);
using UnityEngine;
using System.Collections;

public class ExampleClass : MonoBehaviour {
    public SphereCollider sc;
    void Example() {
        sc = gameObject.AddComponent<SphereCollider>();
    }
}
import UnityEngine
import System.Collections

public class ExampleClass(MonoBehaviour):

	public sc as SphereCollider

	def Example() as void:
		sc = gameObject.AddComponent[of SphereCollider]()

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

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

Description

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