Unity - Scripting API: GameObject.GetComponent

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.

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.

Your name Your email Suggestion*

Cancel

Switch to Manual

Declaration

public Component GetComponent(Type type);

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.

Using gameObject.GetComponent will return the first component that is found and the order is undefined. If you expect there to be more than one component of the same type, use gameObject.GetComponents instead, and cycle through the returned components testing for some unique property.

Declaration

public T GetComponent();

Description

Generic version of this method.

using UnityEngine;public class GetComponentGenericExample : MonoBehaviour
{
    void Start()
    {
        HingeJoint hinge = gameObject.GetComponent<HingeJoint>();
        if (hinge != null)
            hinge.useSpring = false;
    }
}

Declaration

public Component GetComponent(string type);

Parameters

type	The type of Component to retrieve.

Description

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

To improve the performance of your code, use GetComponent with a type instead of a string.

using UnityEngine;public class GetComponentNonPerformantExample : MonoBehaviour
{
    void Start()
    {
        HingeJoint hinge = gameObject.GetComponent("HingeJoint") as HingeJoint;
        if (hinge != null)
            hinge.useSpring = false;
    }
}