Version: 2021.3
LanguageEnglish
  • C#

Component.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

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

Declaration

public Component GetComponent(Type type);

Parameters

type The type of Component to retrieve.

Returns

Component A Component of the matching type, otherwise null if no Component is found.

Description

Returns the component of type if the GameObject has one attached.

Component.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 Component.GetComponents instead, and filter that output further.// To get a component on a different GameObject, use GameObject.Find to get a reference to the other GameObject, and then use GameObject.GetComponent on the other GameObject.

using UnityEngine;

public class GetComponentExample : MonoBehaviour { void Start() { HingeJoint hinge = gameObject.GetComponent(typeof(HingeJoint)) as HingeJoint;

if (hinge != null) hinge.useSpring = false; } }

Declaration

public T GetComponent();

Returns

T A Component of the matching type, otherwise null if no Component is found.

Description

Generic version of this method.

using UnityEngine;

public class GetComponentExample : MonoBehaviour { void Start() { HingeJoint hinge = GetComponent<HingeJoint>();

if (hinge != null) hinge.useSpring = false; } }

Declaration

public Component GetComponent(string type);

Parameters

type The name of the type of Component to get.

Returns

Component A Component of the matching type, otherwise null if no Component is found.

Description

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

using UnityEngine;

public class GetComponentExample : MonoBehaviour { void Start() { HingeJoint hinge = GetComponent("HingeJoint") as HingeJoint;

if (hinge != null) hinge.useSpring = false; } }