Legacy Documentation: Version 5.5
LanguageEnglish
  • C#
  • JS

Script language

Select your preferred scripting language. All code snippets will be displayed in this language.

GameObject.GetComponentInChildren

Switch to Manual
public Component GetComponentInChildren(Type type);
public Component GetComponentInChildren(Type type, bool includeInactive);

Parameters

type The type of Component to retrieve.

Returns

Component A component of the matching type, if found.

Description

Returns the component of Type type in the GameObject or any of its children using depth first search.

A component is returned only if it is found on an active GameObject.

using UnityEngine;

public class GetComponentInChildrenExample : MonoBehaviour { // Disable the spring on the first HingeJoint component found on any child object

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; } } }

public T GetComponentInChildren(bool includeInactive = false);

Returns

T A component of the matching type, if found.

Description

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

using UnityEngine;

public class GetComponentInChildrenExample : MonoBehaviour { // Disable the spring on the first HingeJoint component found on any child object

void Start( ) { HingeJoint hinge = gameObject.GetComponentInChildren<HingeJoint>( );

if( hinge != null ) hinge.useSpring = false; else { // Try again, looking for inactive GameObjects HingeJoint hingeInactive = gameObject.GetComponentInChildren<HingeJoint>( true ) as HingeJoint;

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