Extensions for GameObject, Transform, and String to provide convience methods

JotunnLib/Extensions/GameObjectExtension.cs

@@ -1,7 +1,9 @@
-using System.Reflection;
- using TMPro;
- using UnityEngine;
+using System.Reflection;
+using System;
+using TMPro;
+using UnityEngine;
 using UnityEngine.UI;
+using Jotunn.Extensions;
 
 namespace Jotunn
 {
@@ -26,7 +28,7 @@ public static GameObject OrNull(this GameObject @this)
         /// <typeparam name="T">Any type that inherits MonoBehaviour</typeparam>
         /// <param name="this">this</param>
         /// <returns>Returns null when MonoBehaviours.op_equality returns false.</returns>
-        public static T OrNull<T>(this T @this) where T : Object
+        public static T OrNull<T>(this T @this) where T : UnityEngine.Object
         {
             return (T)(@this ? @this : null);
         }
@@ -104,6 +106,118 @@ public static Component AddComponentCopy<T>(this GameObject gameObject, T duplic
 
             return target;
         }
+
+        /// <summary>
+        ///     Check if GameObject has any of the specified components.
+        /// </summary>
+        /// <param name="gameObject"></param>
+        /// <param name="components"></param>
+        /// <returns></returns>
+        public static bool HasAnyComponent(this GameObject gameObject, params Type[] components)
+        {
+            foreach (var compo in components)
+            {
+                if (gameObject.GetComponent(compo))
+                {
+                    return true;
+                }
+            }
+            return false;
+        }
+
+        /// <summary>
+        ///     Check if GameObject has any of the specified components.
+        /// </summary>
+        /// <param name="gameObject"></param>
+        /// <param name="componentNames"></param>
+        /// <returns></returns>
+        public static bool HasAnyComponent(this GameObject gameObject, params string[] componentNames)
+        {
+            foreach (var name in componentNames)
+            {
+                if (gameObject.GetComponent(name))
+                {
+                    return true;
+                }
+            }
+            return false;
+        }
+
+        /// <summary>
+        ///     Check if GameObject has all of the specified components.
+        /// </summary>
+        /// <param name="gameObject"></param>
+        /// <param name="componentNames"></param>
+        /// <returns></returns>
+        public static bool HasAllComponents(this GameObject gameObject, params string[] componentNames)
+        {
+            foreach (var name in componentNames)
+            {
+                if (!gameObject.GetComponent(name))
+                {
+                    return false;
+                }
+            }
+            return true;
+        }
+
+        /// <summary>
+        ///     Check if GameObject has all of the specified components.
+        /// </summary>
+        /// <param name="gameObject"></param>
+        /// <param name="components"></param>
+        /// <returns></returns>
+        public static bool HasAllComponents(this GameObject gameObject, params Type[] components)
+        {
+            foreach (var compo in components)
+            {
+                if (!gameObject.GetComponent(compo))
+                {
+                    return false;
+                }
+            }
+            return true;
+        }
+
+        /// <summary>
+        ///     Check if GameObject or any of it's children
+        ///     have any of the specified components.
+        /// </summary>
+        /// <param name="gameObject"></param>
+        /// <param name="includeInactive"></param>
+        /// <param name="components"></param>
+        /// <returns></returns>
+        public static bool HasAnyComponentInChildren(
+            this GameObject gameObject,
+            bool includeInactive = false,
+            params Type[] components
+        )
+        {
+            foreach (var compo in components)
+            {
+                if (gameObject.GetComponentInChildren(compo, includeInactive))
+                {
+                    return true;
+                }
+            }
+            return false;
+        }
+
+        /// <summary>
+        ///     Extension method to find nested children by name using either
+        ///     a breadth-first or depth-first search. Default is breadth-first.
+        /// </summary>
+        /// <param name="gameObject"></param>
+        /// <param name="childName">Name of the child object to search for.</param>
+        /// <param name="searchType">Whether to preform a breadth first or depth first search. Default is breadth first.</param>
+        public static Transform FindDeepChild(
+            this GameObject gameObject,
+            string childName,
+            global::Utils.IterativeSearchType searchType = global::Utils.IterativeSearchType.BreadthFirst
+        )
+        {
+            return gameObject.transform.FindDeepChild(childName, searchType);
+        }
     }
 
     /// <summary>

JotunnLib/Extensions/StringExtensions.cs

@@ -0,0 +1,107 @@
+namespace Jotunn.Extensions
+{
+    public static class StringExtensions
+    {
+        /// <summary>
+        ///     Returns true if the string contains any of the substrings.
+        /// </summary>
+        /// <param name="str"></param>
+        /// <param name="substrings"></param>
+        /// <returns></returns>
+        public static bool ContainsAny(this string str, params string[] substrings)
+        {
+            foreach (var substring in substrings)
+            {
+                if (str.Contains(substring))
+                {
+                    return true;
+                }
+            }
+            return false;
+        }
+
+        /// <summary>
+        ///     Returns true if the string ends with any one of the suffixes.
+        /// </summary>
+        /// <param name="str"></param>
+        /// <param name="suffixes"></param>
+        /// <returns></returns>
+        public static bool EndsWithAny(this string str, params string[] suffixes)
+        {
+            foreach (var substring in suffixes)
+            {
+                if (str.EndsWith(substring))
+                {
+                    return true;
+                }
+            }
+            return false;
+        }
+
+        /// <summary>
+        ///     Returns true if the string starts with any one of the prefixes.
+        /// </summary>
+        /// <param name="str"></param>
+        /// <param name="prefixes"></param>
+        /// <returns></returns>
+        public static bool StartsWithAny(this string str, params string[] prefixes)
+        {
+            foreach (var substring in prefixes)
+            {
+                if (str.StartsWith(substring))
+                {
+                    return true;
+                }
+            }
+            return false;
+        }
+
+        /// <summary>
+        ///     If the string ends with the suffix then return a copy of the string
+        ///     with the suffix stripped, otherwise return the original string.
+        /// </summary>
+        /// <param name="s"></param>
+        /// <param name="suffix"></param>
+        /// <returns></returns>
+        public static string RemoveSuffix(this string s, string suffix)
+        {
+            if (s.EndsWith(suffix))
+            {
+                return s.Substring(0, s.Length - suffix.Length);
+            }
+
+            return s;
+        }
+
+        /// <summary>
+        ///     If the string starts with the prefix then return a copy of the string
+        ///     with the prefix stripped, otherwise return the original string.
+        /// </summary>
+        /// <param name="s"></param>
+        /// <param name="prefix"></param>
+        /// <returns></returns>
+        public static string RemovePrefix(this string s, string prefix)
+        {
+            if (s.StartsWith(prefix))
+            {
+                return s.Substring(prefix.Length, s.Length - prefix.Length);
+            }
+            return s;
+        }
+
+        /// <summary>
+        ///     Returns a copy of the string with the first character capitalized
+        /// </summary>
+        /// <param name="s"></param>
+        /// <returns></returns>
+        public static string CapitalizeFirstLetter(this string s)
+        {
+            if (s.Length == 0)
+                return s;
+            else if (s.Length == 1)
+                return $"{char.ToUpper(s[0])}";
+            else
+                return char.ToUpper(s[0]) + s.Substring(1);
+        }
+    }
+}

JotunnLib/Extensions/TransformExtensions.cs

@@ -0,0 +1,27 @@
+using UnityEngine;
+
+namespace Jotunn.Extensions
+{
+    /// <summary>
+    ///     Convenience methods for Transforms
+    /// </summary>
+    public static class TransformExtensions
+    {
+        /// <summary>
+        ///     Extension method to find nested children by name using either
+        ///     a breadth-first or depth-first search. Default is breadth-first.
+        /// </summary>
+        /// <param name="transform"></param>
+        /// <param name="childName">Name of the child object to search for.</param>
+        /// <param name="searchType">Whether to preform a breadth first or depth first search. Default is breadth first.</param>
+        /// <returns></returns>
+        public static Transform FindDeepChild(
+            this Transform transform,
+            string childName,
+            global::Utils.IterativeSearchType searchType = global::Utils.IterativeSearchType.BreadthFirst
+        )
+        {
+            return global::Utils.FindChild(transform, childName, searchType);
+        }
+    }
+}