IEnumerable<T> GetComponentsInChildren( bool includeDisabled, bool includeSelf )

book_4_sparkGenerated
code_blocksInput

Description

The GetComponentsInChildren method retrieves all components of a specified type T from the current GameObject and its descendant GameObjects. This method allows you to specify whether to include components that are disabled and whether to include the component on the current GameObject itself.

Usage

To use the GetComponentsInChildren method, call it on an instance of a Component or a derived class. You need to specify the type of components you want to retrieve using the generic type parameter T. The method takes two boolean parameters:

  • includeDisabled: If set to true, the method will include components that are currently disabled.
  • includeSelf: If set to true, the method will include the component on the current GameObject if it matches the specified type.

Example

// Example of using GetComponentsInChildren to retrieve all MeshRenderer components
// from the current GameObject and its children, including disabled ones.

public void RetrieveMeshRenderers()
{
    IEnumerable<MeshRenderer> meshRenderers = this.GetComponentsInChildren<MeshRenderer>(includeDisabled: true, includeSelf: true);
    foreach (var renderer in meshRenderers)
    {
        // Perform operations with each MeshRenderer
    }
}