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. This method allows you to specify whether to include disabled components and whether to include the current GameObject in the search.

Usage

To use this method, call it on a Component instance, specifying the type of component you are looking for. You can also specify whether to include disabled components and whether to include the current GameObject in the search.

Parameters:

  • includeDisabled (System.Boolean): If set to true, the method will include components that are disabled in the search.
  • includeSelf (System.Boolean): If set to true, the method will include the current GameObject in the search.

Returns: The first component of type T found, or null if no such component exists.

Example

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