Version: 2017.3 (switch to 2017.4)
LanguageEnglish
  • C#
  • JS

Script language

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

Component.GetComponentsInParent

Other Versions
Leave feedback
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

Submission failed

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

Close

Cancel

public method GetComponentsInParent(t: Type, includeInactive: bool = false): Component[];
public Component[] GetComponentsInParent(Type t, bool includeInactive = false);

Parameters

t The type of Component to retrieve.
includeInactive Should inactive Components be included in the found set?

Description

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

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

using UnityEngine;

public class GetComponentsInParentExample : MonoBehaviour
{
    public Component[] hingeJoints;

    void Start()
    {
        // Disable the spring on all HingeJoints
        // in this game object and all its parent game objects
        hingeJoints = (HingeJoint[])gameObject.GetComponentsInParent(typeof(HingeJoint));

        foreach (HingeJoint joint in hingeJoints)
        {
            joint.useSpring = false;
        }
    }
}
public method GetComponentsInParent(includeInactive: bool): T[];
public T[] GetComponentsInParent(bool includeInactive);
public method GetComponentsInParent(): T[];
public T[] GetComponentsInParent();

Parameters

includeInactive Should inactive Components be included in the found set?

Description

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

Did you find this page useful? Please give it a rating:

Is something described here not working as you expect it to? It might be a Known Issue. Please check with the Issue Tracker at issuetracker.unity3d.com.

Copyright © 2018 Unity Technologies. Publication: 2017.3-002A. Built: 2018-04-04.
Tutorials Community Answers Knowledge Base Forums Asset Store LegalPrivacy PolicyCookiesDo Not Sell or Share My Personal Information