com.wallstop-studios.unity-helpers 2.0.0-rc39 → 2.0.0-rc41

package/.github/workflows/npm-publish.yml

@@ -7,15 +7,6 @@ on:
     paths:
       - 'package.json'
   workflow_dispatch:
-    inputs:
-      logLevel:
-        description: 'Log level'
-        required: true
-        default: 'warning'
-      environment:
-        description: 'Environment to deploy'
-        required: false
-        default: 'staging'
 
 jobs:
   publish_npm:
@@ -36,27 +27,32 @@ jobs:
       - name: Check if version changed
         id: version_check
         run: |
-          PREV_VERSION=$(git show HEAD~1:package.json | jq -r '.version' || echo "0.0.0")
-          NEW_VERSION=$(jq -r '.version' package.json)
-          echo "Previous version: $PREV_VERSION"
-          echo "New version: $NEW_VERSION"
-
-          if [ "$PREV_VERSION" != "$NEW_VERSION" ]; then
-            echo "Version changed, proceeding..."
-            echo "NEW_VERSION=$NEW_VERSION" >> $GITHUB_ENV
+          if [ "${{ github.event_name }}" = "workflow_dispatch" ]; then
+            echo "Manual trigger detected. Skipping version check."
             echo "should_publish=true" >> $GITHUB_ENV
+          else
+            PREV_VERSION=$(git show HEAD~1:package.json | jq -r '.version' || echo "0.0.0")
+            NEW_VERSION=$(jq -r '.version' package.json)
+            echo "Previous version: $PREV_VERSION"
+            echo "New version: $NEW_VERSION"
 
-            # Detect pre-releases (versions with "rc" or similar tags)
-            if [[ "$NEW_VERSION" == *"rc"* ]]; then
-              echo "This is a pre-release (next tag)."
-              echo "NPM_TAG=next" >> $GITHUB_ENV
+            if [ "$PREV_VERSION" != "$NEW_VERSION" ]; then
+              echo "Version changed, proceeding..."
+              echo "NEW_VERSION=$NEW_VERSION" >> $GITHUB_ENV
+              echo "should_publish=true" >> $GITHUB_ENV
+
+              # Detect pre-releases (versions with "rc" or similar tags)
+              if [[ "$NEW_VERSION" == *"rc"* ]]; then
+                echo "This is a pre-release (next tag)."
+                echo "NPM_TAG=next" >> $GITHUB_ENV
+              else
+                echo "This is a stable release (latest tag)."
+                echo "NPM_TAG=latest" >> $GITHUB_ENV
+              fi
             else
-              echo "This is a stable release (latest tag)."
-              echo "NPM_TAG=latest" >> $GITHUB_ENV
+              echo "Version did not change, skipping..."
+              echo "should_publish=false" >> $GITHUB_ENV
             fi
-          else
-            echo "Version did not change, skipping..."
-            echo "should_publish=false" >> $GITHUB_ENV
           fi
 
       - name: Install Dependencies

package/Editor/AnimationCopier.cs

@@ -14,12 +14,35 @@
         private string _fullSourcePath;
         private string _fullDestinationPath;
 
-        [ReadOnly]
+        [DxReadOnly]
         public string animationSourcePath;
 
-        [ReadOnly]
+        [DxReadOnly]
         public string animationDestinationPath;
 
+        private void OnEnable()
+        {
+            if (string.IsNullOrWhiteSpace(_fullSourcePath))
+            {
+                _fullSourcePath = $"{Application.dataPath}/Sprites";
+                int assetIndex = _fullSourcePath.IndexOf("Assets", StringComparison.Ordinal);
+                if (0 <= assetIndex)
+                {
+                    animationSourcePath = _fullSourcePath.Substring(assetIndex);
+                }
+            }
+
+            if (string.IsNullOrWhiteSpace(_fullDestinationPath))
+            {
+                _fullDestinationPath = $"{Application.dataPath}/Animations";
+                int assetIndex = _fullDestinationPath.IndexOf("Assets", StringComparison.Ordinal);
+                if (0 <= assetIndex)
+                {
+                    animationDestinationPath = _fullDestinationPath.Substring(assetIndex);
+                }
+            }
+        }
+
         [MenuItem("Tools/Unity Helpers/Animation Copier")]
         public static void CopyAnimations()
         {

package/Editor/AnimationCreator.cs

@@ -14,9 +14,9 @@
     {
         public const int DefaultFramesPerSecond = 12;
 
-        public List<Texture2D> frames;
+        public List<Texture2D> frames = new();
         public int framesPerSecond = DefaultFramesPerSecond;
-        public string animationName;
+        public string animationName = string.Empty;
     }
 
     public sealed class AnimationCreator : ScriptableWizard
@@ -90,11 +90,13 @@
                         int lastNumericIndex = frameName.Length - 1;
                         for (int i = frameName.Length - 1; 0 <= i; --i)
                         {
-                            if (!char.IsNumber(frameName[i]))
+                            if (char.IsNumber(frameName[i]))
                             {
-                                lastNumericIndex = i + 1;
-                                break;
+                                continue;
                             }
+
+                            lastNumericIndex = i + 1;
+                            break;
                         }
 
                         int lastUnderscoreIndex = frameName.LastIndexOf('_');
@@ -118,29 +120,18 @@
                     if (0 < texturesByPrefixAndAssetPath.Count)
                     {
                         animationData.Clear();
-                        foreach (
-                            KeyValuePair<
-                                string,
-                                Dictionary<string, List<Texture2D>>
-                            > assetPathAndTextures in texturesByPrefixAndAssetPath
-                        )
-                        {
-                            foreach (
-                                KeyValuePair<
-                                    string,
-                                    List<Texture2D>
-                                > textureAndPrefix in assetPathAndTextures.Value
+                        animationData.AddRange(
+                            texturesByPrefixAndAssetPath.SelectMany(assetPathAndTextures =>
+                                assetPathAndTextures.Value.Select(
+                                    textureAndPrefix => new AnimationData
+                                    {
+                                        frames = textureAndPrefix.Value,
+                                        framesPerSecond = data.framesPerSecond,
+                                        animationName = $"Anim_{textureAndPrefix.Key}",
+                                    }
+                                )
                             )
-                            {
-                                AnimationData newData = new()
-                                {
-                                    frames = textureAndPrefix.Value,
-                                    framesPerSecond = data.framesPerSecond,
-                                    animationName = $"Anim_{textureAndPrefix.Key}",
-                                };
-                                animationData.Add(newData);
-                            }
-                        }
+                        );
                     }
                 }
             }

package/Editor/AnimatorControllerCopier.cs

@@ -14,11 +14,11 @@
         private string _fullSourcePath;
         private string _fullDestinationPath;
 
-        [ReadOnly]
+        [DxReadOnly]
         public string controllerSourcePath;
 
-        [ReadOnly]
-        public string controllerDestinationpath;
+        [DxReadOnly]
+        public string controllerDestinationPath;
 
         [MenuItem("Tools/Unity Helpers/Animator Controller Copier")]
         public static void CopyAnimations()
@@ -61,8 +61,8 @@
                     return false;
                 }
 
-                _fullDestinationPath = controllerDestinationpath = sourcePath ?? string.Empty;
-                controllerDestinationpath = controllerDestinationpath.Substring(assetIndex);
+                _fullDestinationPath = controllerDestinationPath = sourcePath ?? string.Empty;
+                controllerDestinationPath = controllerDestinationPath.Substring(assetIndex);
                 return true;
             }
 
@@ -78,7 +78,7 @@
 
             if (
                 string.IsNullOrEmpty(controllerSourcePath)
-                || string.IsNullOrEmpty(controllerDestinationpath)
+                || string.IsNullOrEmpty(controllerDestinationPath)
             )
             {
                 return;
@@ -130,7 +130,7 @@
                 }
 
                 string destination =
-                    controllerDestinationpath + partialPath + relativePath.Substring(prefixIndex);
+                    controllerDestinationPath + partialPath + relativePath.Substring(prefixIndex);
                 bool copySuccessful = AssetDatabase.CopyAsset(path, destination);
                 if (copySuccessful)
                 {

package/Editor/EnsureTextureSizeWizard.cs

@@ -22,22 +22,27 @@
         {
             textures ??= new List<Texture2D>();
             textureSourcePaths ??= new List<Object>();
-            HashSet<string> texturePath = new();
-            foreach (Object textureSource in textureSourcePaths)
+            HashSet<string> texturePaths = new();
+            foreach (
+                string assetPath in textureSourcePaths
+                    .Select(AssetDatabase.GetAssetPath)
+                    .Where(assetPath => !string.IsNullOrWhiteSpace(assetPath))
+            )
             {
-                string assetPath = AssetDatabase.GetAssetPath(textureSource);
-                if (!string.IsNullOrWhiteSpace(assetPath))
-                {
-                    _ = texturePath.Add(assetPath);
-                }
+                _ = texturePaths.Add(assetPath);
+            }
+
+            if (!textures.Any() && !texturePaths.Any())
+            {
+                texturePaths.Add("Assets");
             }
 
-            if (texturePath.Any())
+            if (texturePaths.Any())
             {
                 foreach (
                     string assetGuid in AssetDatabase.FindAssets(
                         "t:texture2D",
-                        texturePath.ToArray()
+                        texturePaths.ToArray()
                     )
                 )
                 {

package/Editor/PrefabCheckWizard.cs

@@ -21,7 +21,7 @@
         [Tooltip(
             "Drag a folder from Unity here to validate all prefabs under it. Defaults to Assets/Prefabs and Assets/Resources if none specified."
         )]
-        public List<Object> assetPaths;
+        public List<Object> assetPaths = new();
 
         [MenuItem("Tools/Unity Helpers/Prefab Check Wizard")]
         public static void CreatePrefabCheckWizard()

package/Editor/Utils/{ReadOnlyPropertyDrawer.cs → DxReadOnlyPropertyDrawer.cs}

@@ -6,8 +6,8 @@
     using UnityEngine;
 
     // https://www.patrykgalach.com/2020/01/20/readonly-attribute-in-unity-editor/
-    [CustomPropertyDrawer(typeof(ReadOnlyAttribute))]
-    public sealed class ReadOnlyPropertyDrawer : PropertyDrawer
+    [CustomPropertyDrawer(typeof(DxReadOnlyAttribute))]
+    public sealed class DxReadOnlyPropertyDrawer : PropertyDrawer
     {
         public override float GetPropertyHeight(SerializedProperty property, GUIContent label)
         {

package/README.md

@@ -3,7 +3,6 @@ Various Unity Helpers. Includes many deterministic, seedable random number gener
 
 # CI/CD Status
 ![Npm Publish](https://github.com/wallstop/unity-helpers/actions/workflows/npm-publish.yml/badge.svg)
-![Deploy](https://github.com/wallstop/unity-helpers/actions/workflows/unity-package.yml/badge.svg)
 
 # Compatibility
 | Platform | Compatible |
@@ -51,6 +50,43 @@ Check out the latest [Releases](https://github.com/wallstop/unity-helpers/releas
 - A randomizable PerlinNoise implementation
 - And more!
 
+# Auto Get(Parent/Sibling/Child)Component
+Are you tired of constantly writing GetComponent<T>() all over the place? Waste time no more!
+
+```csharp
+public sealed class MyCoolScript : MonoBehaviour
+{
+    [SiblingComponent] // If it doesn't exist, will log an error
+    private SpriteRenderer _spriteRenderer;
+
+    [SiblingComponent(optional = true)] // Ok if it doesn't exist, no errors logged
+    private BoxCollider2D _boxCollider;
+
+    [ParentComponent] // Similar to GetComponentInParent<AIController>(includeInactive: true)
+    private AIController _parentAIController;
+
+    // Only include components in parents, Unity by default includes sibling components in the GetComponentsInParent call
+    [ParentComponent(onlyAncestors = true)] 
+    private Transform [] _allParentTransforms; // Works with arrays!
+
+    [ParentComponent(includeInactive = false)] // Don't include inactive components
+    private List<PolygonCollider2> _parentColliders; // Works with lists!
+
+    [ChildComponent(onlyDescendents = true)] // Similar to GetComponentInChildren<EdgeCollider2D>(includeInactive: true)
+    private EdgeCollider2D _childEdgeCollider;
+
+    private void Awake()
+    {
+        /*
+            Make sure this is called somewhere, usually in Awake, OnEnable, or Start - wherever this is called,
+             values will be injected into the annotated fields and errors will be logged
+        */
+        this.AssignRelationalComponents();
+    }
+}
+
+```
+
 # Random Number Generators
 This package implements several high quality, seedable, and serializable random number generators. The best one (currently) is the PCG Random. This has been hidden behind the `PRNG.Instance` class, which is thread-safe. As the package evolves, the exact implementation of this may change.
 

package/Runtime/Core/Attributes/ChildComponentAttribute.cs

@@ -15,6 +15,7 @@
     public sealed class ChildComponentAttribute : Attribute
     {
         public bool optional = false;
+        public bool includeInactive = true;
         public bool onlyDescendents = false;
     }
 
@@ -37,7 +38,7 @@
                     );
                     return fields
                         .Where(field => Attribute.IsDefined(field, typeof(ChildComponentAttribute)))
-                        .Select(field => (field, ReflectionHelpers.CreateFieldSetter(type, field)))
+                        .Select(field => (field, ReflectionHelpers.GetFieldSetter(field)))
                         .ToArray();
                 }
             );
@@ -49,7 +50,9 @@
                 Type childComponentType = isArray ? fieldType.GetElementType() : fieldType;
 
                 bool foundChild;
-                if (field.GetCustomAttribute<ChildComponentAttribute>().onlyDescendents)
+                ChildComponentAttribute customAttribute =
+                    field.GetCustomAttribute<ChildComponentAttribute>();
+                if (customAttribute.onlyDescendents)
                 {
                     if (isArray)
                     {
@@ -57,7 +60,10 @@
                         foreach (Transform child in component.IterateOverAllChildren())
                         {
                             children.AddRange(
-                                child.GetComponentsInChildren(childComponentType, true)
+                                child.GetComponentsInChildren(
+                                    childComponentType,
+                                    customAttribute.includeInactive
+                                )
                             );
                         }
 
@@ -83,7 +89,10 @@
                             Component childComponent in component
                                 .IterateOverAllChildren()
                                 .SelectMany(child =>
-                                    child.GetComponentsInChildren(childComponentType, true)
+                                    child.GetComponentsInChildren(
+                                        childComponentType,
+                                        customAttribute.includeInactive
+                                    )
                                 )
                         )
                         {
@@ -97,14 +106,27 @@
                     {
                         foundChild = false;
                         Component childComponent = null;
-                        foreach (Transform child in component.IterateOverAllChildren())
+                        foreach (
+                            Transform child in component.IterateOverAllChildrenRecursivelyBreadthFirst()
+                        )
                         {
                             childComponent = child.GetComponent(childComponentType);
-                            if (childComponent != null)
+                            if (
+                                childComponent == null
+                                || (
+                                    !customAttribute.includeInactive
+                                    && (
+                                        !childComponent.gameObject.activeInHierarchy
+                                        || childComponent is Behaviour { enabled: false }
+                                    )
+                                )
+                            )
                             {
-                                foundChild = true;
-                                break;
+                                continue;
                             }
+
+                            foundChild = true;
+                            break;
                         }
                         if (foundChild)
                         {
@@ -118,7 +140,7 @@
                     {
                         Component[] childComponents = component.GetComponentsInChildren(
                             childComponentType,
-                            true
+                            customAttribute.includeInactive
                         );
                         foundChild = 0 < childComponents.Length;
 
@@ -149,7 +171,7 @@
                         foreach (
                             Component childComponent in component.GetComponentsInChildren(
                                 childComponentType,
-                                true
+                                customAttribute.includeInactive
                             )
                         )
                         {
@@ -163,7 +185,7 @@
                     {
                         Component childComponent = component.GetComponentInChildren(
                             childComponentType,
-                            true
+                            customAttribute.includeInactive
                         );
                         foundChild = childComponent != null;
                         if (foundChild)
@@ -173,15 +195,13 @@
                     }
                 }
 
-                if (!foundChild)
+                if (
+                    !foundChild
+                    && field.GetCustomAttributes(typeof(ChildComponentAttribute), false)[0]
+                        is ChildComponentAttribute { optional: false }
+                )
                 {
-                    if (
-                        field.GetCustomAttributes(typeof(ChildComponentAttribute), false)[0]
-                        is ChildComponentAttribute { optional: false } _
-                    )
-                    {
-                        component.LogError($"Unable to find child component of type {fieldType}");
-                    }
+                    component.LogError($"Unable to find child component of type {fieldType}");
                 }
             }
         }

package/Runtime/Core/Attributes/DxReadOnlyAttribute.cs

@@ -0,0 +1,6 @@
+namespace UnityHelpers.Core.Attributes
+{
+    using PropertyAttribute = UnityEngine.PropertyAttribute;
+
+    public sealed class DxReadOnlyAttribute : PropertyAttribute { }
+}

package/Runtime/Core/Attributes/ParentComponent.cs

@@ -15,6 +15,7 @@
     public sealed class ParentComponentAttribute : Attribute
     {
         public bool optional = false;
+        public bool includeInactive = true;
         public bool onlyAncestors = false;
     }
 
@@ -39,7 +40,7 @@
                         .Where(field =>
                             Attribute.IsDefined(field, typeof(ParentComponentAttribute))
                         )
-                        .Select(field => (field, ReflectionHelpers.CreateFieldSetter(type, field)))
+                        .Select(field => (field, ReflectionHelpers.GetFieldSetter(field)))
                         .ToArray();
                 }
             );
@@ -51,6 +52,8 @@
                 Type parentComponentType = isArray ? fieldType.GetElementType() : fieldType;
 
                 bool foundParent;
+                ParentComponentAttribute customAttribute =
+                    field.GetCustomAttribute<ParentComponentAttribute>();
                 if (field.GetCustomAttribute<ParentComponentAttribute>().onlyAncestors)
                 {
                     Transform parent = component.transform.parent;
@@ -62,7 +65,7 @@
                     {
                         Component[] parentComponents = parent.GetComponentsInParent(
                             parentComponentType,
-                            true
+                            customAttribute.includeInactive
                         );
                         foundParent = 0 < parentComponents.Length;
 
@@ -82,7 +85,7 @@
 
                         Component[] parents = parent.GetComponentsInParent(
                             parentComponentType,
-                            true
+                            customAttribute.includeInactive
                         );
 
                         IList instance = ReflectionHelpers.CreateList(
@@ -103,7 +106,7 @@
                     {
                         Component childComponent = parent.GetComponentInParent(
                             parentComponentType,
-                            true
+                            customAttribute.includeInactive
                         );
                         foundParent = childComponent != null;
                         if (foundParent)
@@ -118,7 +121,7 @@
                     {
                         Component[] parentComponents = component.GetComponentsInParent(
                             parentComponentType,
-                            true
+                            customAttribute.includeInactive
                         );
                         foundParent = 0 < parentComponents.Length;
 
@@ -138,7 +141,7 @@
 
                         Component[] parents = component.GetComponentsInParent(
                             parentComponentType,
-                            true
+                            customAttribute.includeInactive
                         );
 
                         IList instance = ReflectionHelpers.CreateList(
@@ -158,7 +161,7 @@
                     {
                         Component childComponent = component.GetComponentInParent(
                             parentComponentType,
-                            true
+                            customAttribute.includeInactive
                         );
                         foundParent = childComponent != null;
                         if (foundParent)
@@ -168,15 +171,13 @@
                     }
                 }
 
-                if (!foundParent)
+                if (
+                    !foundParent
+                    && field.GetCustomAttributes(typeof(ParentComponentAttribute), false)[0]
+                        is ParentComponentAttribute { optional: false }
+                )
                 {
-                    if (
-                        field.GetCustomAttributes(typeof(ParentComponentAttribute), false)[0]
-                        is ParentComponentAttribute { optional: false } _
-                    )
-                    {
-                        component.LogError($"Unable to find parent component of type {fieldType}");
-                    }
+                    component.LogError($"Unable to find parent component of type {fieldType}");
                 }
             }
         }

package/Runtime/Core/Attributes/SiblingComponentAttribute.cs

@@ -38,7 +38,7 @@
                         .Where(field =>
                             Attribute.IsDefined(field, typeof(SiblingComponentAttribute))
                         )
-                        .Select(field => (field, ReflectionHelpers.CreateFieldSetter(type, field)))
+                        .Select(field => (field, ReflectionHelpers.GetFieldSetter(field)))
                         .ToArray();
                 }
             );
@@ -103,15 +103,13 @@
                     }
                 }
 
-                if (!foundSibling)
+                if (
+                    !foundSibling
+                    && field.GetCustomAttributes(typeof(SiblingComponentAttribute), false)[0]
+                        is SiblingComponentAttribute { optional: false }
+                )
                 {
-                    if (
-                        field.GetCustomAttributes(typeof(SiblingComponentAttribute), false)[0]
-                        is SiblingComponentAttribute { optional: false } _
-                    )
-                    {
-                        component.LogError($"Unable to find sibling component of type {fieldType}");
-                    }
+                    component.LogError($"Unable to find sibling component of type {fieldType}");
                 }
             }
         }

package/Runtime/Core/Helper/Partials/TransformHelpers.cs

@@ -1,6 +1,7 @@
 namespace UnityHelpers.Core.Helper
 {
     using System.Collections.Generic;
+    using System.Linq;
     using UnityEngine;
 
     public static partial class Helpers
@@ -163,5 +164,30 @@
                 }
             }
         }
+
+        public static IEnumerable<Transform> IterateOverAllChildrenRecursivelyBreadthFirst(
+            this Component component
+        )
+        {
+            if (component == null)
+            {
+                return Enumerable.Empty<Transform>();
+            }
+
+            Queue<Transform> results = new();
+            Queue<Transform> iteration = new();
+            iteration.Enqueue(component.transform);
+            while (iteration.TryDequeue(out Transform current))
+            {
+                for (int i = 0; i < current.childCount; ++i)
+                {
+                    Transform childTransform = current.GetChild(i);
+                    results.Enqueue(childTransform);
+                    iteration.Enqueue(childTransform);
+                }
+            }
+
+            return results;
+        }
     }
 }