год и 10 месяцев назад
Расширения TryGetComponent для поиска компонентов в Unity

При разработке игр на Unity часто возникает необходимость поиска компонентов на дочерних объектах. Обычно для этих целей используются методы GetComponentInChildren, однако они не предоставляют удобного способа проверить, был ли компонент найден. В стандартных ситуациях это может привести к необходимости дополнительной проверки на null, что загромождает код.

Чтобы сделать код чище и понятнее, можно создать методы расширения, аналогичные TryGetComponent, но для поиска компонентов в дочерних объектах. Вот пример кода:

using UnityEngine;



public static class ComponentExtensions

{

    // Расширение для GameObject - поиск компонента в дочерних объектах

    public static bool TryGetComponentInChildren<T>(this GameObject obj, out T result) where T : Component

    {

        result = obj.GetComponentInChildren<T>(includeInactive: true);

        return result != null;

    }



    // Расширение для Component - поиск компонента в дочерних объектах

    public static bool TryGetComponentInChildren<T>(this Component component, out T result) where T : Component

    {

        result = component.GetComponentInChildren<T>(includeInactive: true);

        return result != null;

    }



    // Расширение для GameObject - поиск всех компонентов типа T в дочерних объектах

    public static bool TryGetComponentsInChildren<T>(this GameObject obj, out T[] results) where T : Component

    {

        results = obj.GetComponentsInChildren<T>(includeInactive: true);

        return results.Length > 0;

    }



    // Расширение для Component - поиск всех компонентов типа T в дочерних объектах

    public static bool TryGetComponentsInChildren<T>(this Component component, out T[] results) where T : Component

    {

        results = component.GetComponentsInChildren<T>(includeInactive: true);

        return results.Length > 0;

    }

}

Разберём, как это работает:
TryGetComponentInChildren:

Эти методы расширения проверяют наличие компонента в дочерних объектах с помощью GetComponentInChildren.
Если компонент найден, он возвращается через out параметр, а метод возвращает true.
В случае, если компонент не найден, возвращается false, и out параметр устанавливается в null.
Параметр includeInactive: true указывает, что поиск будет включать неактивные дочерние объекты.
TryGetComponentsInChildren:

Эти методы ищут все компоненты указанного типа в дочерних объектах с помощью GetComponentsInChildren.
Возвращается массив найденных компонентов, а метод возвращает true, если найдены один или несколько компонентов.
Если же массив пустой, метод возвращает false.
Пример использования:

void Start()

{

    GameObject player = GameObject.Find("Player");

    

    if (player.TryGetComponentInChildren(out Rigidbody rb))

    {

        Debug.Log("Компонент Rigidbody найден!");

    }

    else

    {

        Debug.Log("Компонент Rigidbody не найден.");

    }



    if (player.TryGetComponentsInChildren(out Collider[] colliders))

    {

        Debug.Log($"Найдено коллайдеров: {colliders.Length}");

    }

}

Преимущества использования методов расширения:
Чистота кода:

Благодаря использованию TryGetComponentInChildren, вы избавляетесь от необходимости явно проверять результат на null.
Читаемость:

Использование методов с предикатом Try сразу показывает, что функция может завершиться неудачно, что делает код более предсказуемым и понятным.
Гибкость:

Методы работают как для GameObject, так и для любого компонента, что позволяет использовать их в более широком спектре ситуаций.
Эти методы расширения помогут вам улучшить архитектуру вашего проекта, сделают код проще и избавят от необходимости постоянных проверок на наличие компонентов. Использование TryGetComponentInChildren позволяет более эффективно находить компоненты в дочерних объектах, что особенно полезно при работе с крупными иерархиями объектов в Unity.