GetComponentsInParent
The non-generic version of this method.
Read time 5 minutesLast updated 5 days ago
Definition
- Type: Method
- Namespace: UnityEngine
- Assembly: UnityEngine.CoreModule
GetComponentsInParent(Type, bool)
The non-generic version of this method.
public Component[] GetComponentsInParent(Type t, bool includeInactive)
Parameters
Returns
Type | Description |
|---|---|
| Component[] | An array of all found components matching the specified type. |
Remarks
This version of GetComponentsInChildren is not as efficient as the Generic version (above), so you should only use it if necessary.
GetComponentsInParent<T>(bool)
Gets references to all components of type on the same GameObject as the component specified, and any parent of the GameObject.
Tpublic T[] GetComponentsInParent<T>(bool includeInactive)
Parameters
Whether to include inactive parent GameObjects in the search.
Returns
Type | Description |
|---|---|
| <T>[] | An array containing all matching components of type |
Remarks
The typical usage for this method is to call it from a MonoBehaviour script (which itself is a type of component), to find references to other Components or MonoBehaviours attached to the same GameObject as that script, or its parent GameObjects. In this case you can call the method with no preceding object specified. For example:
myResults = GetComponentsInParent<ComponentType>()You can also call this method on a reference to different component, which might be attached to a different GameObject. In this case, the GameObject to which that component is attached, and its parents, are searched. For example:
myResults = otherComponent.GetComponentsInParent<ComponentType>()This method checks the GameObject on which it is called first, then recurses upwards through each parent GameObject, until it finds a matching Component of the type specified.
TOnly active GameObjects are included in the search, unless you call the method with the parameter set to , in which case inactive GameObjects are also included. This applies to the GameObject on which the method is called.
includeInactivetrueTo 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 on that reference.
GetComponentsInParentSee the Component and GameObject class reference pages for the other variations of the family of methods.
GetComponentThe following example gets a reference to all hinge joint components on the same GameObject as the script, or any of its parents, and if found, sets a property on those components.
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 = GetComponentsInParent<HingeJoint>(); foreach (HingeJoint joint in hingeJoints) { joint.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 for that component.
nullGetComponentsInParent<T>(bool, List<T>)
A variation of the GetComponentsInParent method which allows you to supply your own List to be filled with results.
public void GetComponentsInParent<T>(bool includeInactive, List<T> results)
Parameters
Remarks
This allows you to avoid allocating new List objects for each call to the method. The list you supply is resized to match the number of results found, and any existing values in the list are overwritten.
GetComponentsInParent<T>()
Gets references to all components of type on the same GameObject as the component specified, and any parent of the GameObject.
Tpublic T[] GetComponentsInParent<T>()
Returns
Type | Description |
|---|---|
| <T>[] | An array containing all matching components of type |
Remarks
The typical usage for this method is to call it from a MonoBehaviour script (which itself is a type of component), to find references to other Components or MonoBehaviours attached to the same GameObject as that script, or its parent GameObjects. In this case you can call the method with no preceding object specified. For example:
myResults = GetComponentsInParent<ComponentType>()You can also call this method on a reference to different component, which might be attached to a different GameObject. In this case, the GameObject to which that component is attached, and its parents, are searched. For example:
myResults = otherComponent.GetComponentsInParent<ComponentType>()This method checks the GameObject on which it is called first, then recurses upwards through each parent GameObject, until it finds a matching Component of the type specified.
TOnly active GameObjects are included in the search, unless you call the method with the parameter set to , in which case inactive GameObjects are also included. This applies to the GameObject on which the method is called.
includeInactivetrueTo 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 on that reference.
GetComponentsInParentSee the Component and GameObject class reference pages for the other variations of the family of methods.
GetComponentThe following example gets a reference to all hinge joint components on the same GameObject as the script, or any of its parents, and if found, sets a property on those components.
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 = GetComponentsInParent<HingeJoint>(); foreach (HingeJoint joint in hingeJoints) { joint.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 for that component.
null