T GetComponentInParent( bool includeDisabled, bool includeSelf )

book_4_sparkGenerated
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 is useful when you need to access a component that might be located on a parent object rather than the current object itself.

Usage

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

  • includeDisabled: If set to true, the method will consider components that are currently disabled. If false, only enabled components will be considered.
  • includeSelf: If set to true, the method will include the current GameObject in the search. If false, the search will start from the parent of the current GameObject.

Example

// Example of using GetComponentInParent<T>
public class ExampleComponent : Component
{
    public void FindParentComponent()
    {
        // Attempt to find a component of type MyComponent in the parent hierarchy
        MyComponent parentComponent = GetComponentInParent<MyComponent>(includeDisabled: false, includeSelf: true);
        
        if (parentComponent != null)
        {
            // Do something with the found component
            parentComponent.DoSomething();
        }
        else
        {
            // Handle the case where the component was not found
            Log.Warning("MyComponent not found in parent hierarchy.");
        }
    }
}