Version: 2019.3
LanguageEnglish
  • C#

GameObject.TryGetComponent

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

Parameters

typeThe type of component to retrieve.
componentThe output argument that will contain the component or null.

Returns

bool Returns true if the component is found, false otherwise.

Description

Gets the component of the specified type, if it exists.

TryGetComponent will attempt to retrieve the component of the given type. The notable difference compared to GameObject.GetComponent is that this method does not allocate in the editor when the requested component does not exist.

using UnityEngine;

public class TryGetComponentExample : MonoBehaviour { void Start() { if (gameObject.TryGetComponent(typeof(HingeJoint), out Component component)) { component.name = "My Hinge"; } } }

public bool TryGetComponent(out T component);

Parameters

componentThe output argument that will contain the component or null.

Returns

bool Returns true if the component is found, false otherwise.

Description

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

using UnityEngine;

public class TryGetComponentGenericExample : MonoBehaviour { void Start() { if (TryGetComponent(out HingeJoint hinge)) { hinge.useSpring = false; } } }