T GetComponentInParent( bool includeDisabled, bool includeSelf )

robot_2Generated
code_blocksInput

Description

The GetComponentInParent<T> method is used to retrieve a component of type T from the current GameObject or any of its ancestor GameObjects in the hierarchy. This method can be configured to include disabled components and to include the component on the current GameObject itself.

Usage

To use this method, specify the type of component you are looking for as the generic type parameter T. The method takes two boolean parameters:

  • includeDisabled: If set to true, the method will consider components that are currently disabled.
  • includeSelf: If set to true, the method will include the current GameObject in the search.

The method returns the first component of type T found, or null if no such component exists.

Example

// Example usage of GetComponentInParent<T>
public class ExampleComponent : Component
{
    public void FindComponent()
    {
        // Attempt to find a Rigidbody component in the parent hierarchy
        Rigidbody rb = GetComponentInParent<Rigidbody>(includeDisabled: false, includeSelf: true);
        if (rb != null)
        {
            // Do something with the Rigidbody
        }
    }
}