Language: English
  • C#
  • JS
  • Boo

Script language

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

GameObject.GetComponent

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

GetComponent(type: Type): Component;
Component GetComponent(Type type);
def GetComponent(type as Type) as Component

Parameters

type The type of Component to retrieve.

Description

Returns the component of Type type if the game object has one attached, null if it doesn't.

GetComponent is the primary way of accessing other components. From javascript the type of a script is always the name of the script as seen in the project view. You can access both builtin components or scripts with this function.

// Disable the spring on the HingeJoint component.

var hinge : HingeJoint; hinge = gameObject.GetComponent(HingeJoint); hinge.useSpring = false;
using UnityEngine;
using System.Collections;

public class ExampleClass : MonoBehaviour {
    public HingeJoint hinge;
    void Example() {
        hinge = gameObject.GetComponent<HingeJoint>();
        hinge.useSpring = false;
    }
}
import UnityEngine
import System.Collections

public class ExampleClass(MonoBehaviour):

	public hinge as HingeJoint

	def Example() as void:
		hinge = gameObject.GetComponent[of HingeJoint]()
		hinge.useSpring = false

GetComponent(): T;
T GetComponent();
def GetComponent() as T

Description

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

GetComponent(type: string): Component;
Component GetComponent(string type);
def GetComponent(type as string) as Component

Parameters

type The type of Component to retrieve.

Description

Returns the component with name type if the game object has one attached, null if it doesn't.

It is better to use GetComponent with a Type instead of a string for performance reasons. Sometimes you might not be able to get to the type however, for example when trying to access a C# script from Javascript. In that case you can simply access the component by name instead of type.

// Disable the spring on the HingeJoint component.

var hinge : HingeJoint; hinge = gameObject.GetComponent("HingeJoint"); hinge.useSpring = false;
using UnityEngine;
using System.Collections;

public class ExampleClass : MonoBehaviour {
    public HingeJoint hinge;
    void Example() {
        hinge = gameObject.GetComponent("HingeJoint") as HingeJoint;
        hinge.useSpring = false;
    }
}
import UnityEngine
import System.Collections

public class ExampleClass(MonoBehaviour):

	public hinge as HingeJoint

	def Example() as void:
		hinge = (gameObject.GetComponent('HingeJoint') as HingeJoint)
		hinge.useSpring = false