| includeInactive | Whether to include inactive child GameObjects in the search. |
T
A Component of the matching type T, otherwise null if no Component is found.
Gets a reference to a component of type T on the specified GameObject, or any child of the GameObject.
This method checks the GameObject on which it is called first, then recurses downwards through all child GameObjects using a depth-first search, until it finds a matching Component of the type T specified.
Only active child GameObjects are included in the search, unless you call the method with the includeInactive parameter set to true, in which case inactive child GameObjects are also included. The GameObject on which the method is called is always searched regardless of this parameter.
The typical usage for this method is to call it on a reference to a different GameObject than the one your script is on. For example:myResults = otherGameObject.GetComponentInChildren<ComponentType>()
However if you are writing code inside a MonoBehaviour class, you can also the preceding GameObject reference to perform the search on the same GameObject your script is attached to, and its children. In this instance, you are actually calling Component.GetComponentInChildren because the script itself is a type of component, but the result is the same as if you had referenced the GameObject itself. For example:myResults = GetComponentInChildren<ComponentType>()
Note: GetComponentInChildren returns only the first matching component found, and the order that the components are checked on any individual GameObject is not defined. Therefore, if there are more than one of the specified type that could match on any individual GameObject, and you need to find a specific one, you should use Component.GetComponentsInChildren and check the list of components returned to identify the one you want.
To find components attached to other GameObjects, you need a reference to that other GameObject (or any component attached to that GameObject). You can then call GetComponentInChildren on that reference.
See the Component and GameObject class reference pages for the other variations of the GetComponent family of methods.
The following example gets a reference to a hinge joint component on the referenced GameObject, or any of its children, and if found, sets a property on that hinge joint component.
using UnityEngine;
public class GetComponentInChildrenExample : MonoBehaviour { // Disable the spring on the first HingeJoint component found on the referenced GameObject or any of its children
public GameObject objectToCheck;
void Start() { HingeJoint hinge = objectToCheck.GetComponentInChildren<HingeJoint>();
if (hinge != null) { hinge.useSpring = false; } else { // Try again, looking for inactive GameObjects HingeJoint hingeInactive = objectToCheck.GetComponentInChildren<HingeJoint>(true);
if (hingeInactive != null) { hingeInactive.useSpring = false; } } } }
Note: If the type you request is a derivative of MonoBehaviour and the associated script can't be loaded then this function will return `null` for that component.
| type | The type of Component to retrieve. |
| includeInactive | Whether to include inactive child GameObjects in the search. |
Component A component of the matching type, if found.
This is the non-generic version of this method.
This version of GetComponentInChildren is not as efficient as the Generic version (above), so you should only use it if necessary.
using UnityEngine;
public class GetComponentInChildrenExample : MonoBehaviour { // Disable the spring on the first HingeJoint component found on the referenced GameObject or any of its children
public GameObject objectToCheck;
void Start() { HingeJoint hinge = gameObject.GetComponentInChildren(typeof(HingeJoint)) as HingeJoint;
if (hinge != null) { hinge.useSpring = false; } else { // Try again, looking for inactive GameObjects HingeJoint hingeInactive = gameObject.GetComponentInChildren(typeof(HingeJoint), true) as HingeJoint;
if (hingeInactive != null) { hingeInactive.useSpring = false; } } } }