component | The out parameter that will contain the component or null . |
bool
Returns true
if the component is found, false
otherwise.
Retrieves the component of the specified type, if it exists.
TryGetComponent
attempts to retrieve the component of the given type. The notable difference compared to GameObject.GetComponent is that this method does not allocate memory in the Editor when the requested component does not exist.
using UnityEngine;
public class TryGetComponentExample : MonoBehaviour { public GameObject objectToCheck;
void Start() { if (objectToCheck.TryGetComponent<HingeJoint>(out HingeJoint hinge)) { hinge.useSpring = false; } } }
Additional resources: Component, GameObject.GetComponent
type | The type of component to search for. |
component | The out parameter that will contain the component or null . |
bool
Returns true
if the component is found, false
otherwise.
The non-generic version of this method.
This version of TryGetComponent
is not as efficient as the Generic version (above), so you should only use it if necessary.