LanguageEnglish
  • C#
  • JS

Script language

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

GameObject.GetComponentInChildren

Suggest a change

Success!

Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.

Close

Sumbission failed

For some reason your suggested change could not be submitted. Please try again in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

Switch to Manual
public function GetComponentInChildren(type: Type): Component;
public Component GetComponentInChildren(Type type);

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.

// Disable the spring of the first HingeJoint component
// found on any child object.

var hinge : HingeJoint;
hinge = gameObject.GetComponentInChildren(HingeJoint);
hinge.useSpring = false;

using UnityEngine;
using System.Collections;

public class ExampleClass : MonoBehaviour {
    public HingeJoint hinge;
    void Example() {
        hinge = gameObject.GetComponentInChildren<HingeJoint>();
        hinge.useSpring = false;
    }
}
public function GetComponentInChildren(includeInactive: bool = false): T;
public T GetComponentInChildren(bool includeInactive = false);

Parameters

Returns

T A component of the matching type, if found.

Description

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

Copyright © 2015 Unity Technologies
Learn Community Asset Store Buy Download