Legacy Documentation: Version 4.5.0

Script language:

  • JS
  • C#
  • Boo
Script language

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

GameObject.GetComponentsInChildren

GetComponentsInChildren(type: Type, includeInactive: bool = false): Component[];
Component[] GetComponentsInChildren(Type type, bool includeInactive = false);
def GetComponentsInChildren(type as Type, includeInactive as bool = false) as Component[]

Parameters

typeThe type of Component to retrieve.
includeInactiveShould inactive Components be included in the found set?

Description

Returns all components of Type type in the GameObject or any of its children.

The search for components is carried out recursively on child objects, so it includes children of children, and so on.

	// Disable the spring on all HingeJoints 
	// in this game object and all its child game objects
	var hingeJoints : HingeJoint[];
	hingeJoints = gameObject.GetComponentsInChildren(HingeJoint);
	for (var joint : HingeJoint in hingeJoints) {
		joint.useSpring = false;
	}
using UnityEngine;
using System.Collections;

public class ExampleClass : MonoBehaviour {
    public HingeJoint[] hingeJoints;
    void Example() {
        hingeJoints = gameObject.GetComponentsInChildren<HingeJoint>();
        foreach (HingeJoint joint in hingeJoints) {
            joint.useSpring = false;
        }
    }
}
import UnityEngine
import System.Collections

public class ExampleClass(MonoBehaviour):

	public hingeJoints as (HingeJoint)

	def Example() as void:
		hingeJoints = gameObject.GetComponentsInChildren[of HingeJoint]()
		for joint as HingeJoint in hingeJoints:
			joint.useSpring = false

GetComponentsInChildren(includeInactive: bool): T[];
T[] GetComponentsInChildren(bool includeInactive);
def GetComponentsInChildren(includeInactive as bool) as T[]

Parameters

includeInactiveShould inactive Components be included in the found set?

Description

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

GetComponentsInChildren(): T[];
T[] GetComponentsInChildren();
def GetComponentsInChildren() as T[]

Description

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