type | The type of component to retrieve. |
component | The output argument that will contain the component or null . |
bool
Returns true
if the component is found, false
otherwise.
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"; } } }
component | The output argument that will contain the component or null . |
bool
Returns true
if the component is found, false
otherwise.
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; } } }