chore(release): 4.10.4 [skip ci]

## [4.10.4](https://github.com/mob-sakai/ParticleEffectForUGUI/compare/v4.10.3...v4.10.4) (2024-12-19)

### Bug Fixes

* rendering issues when playing with opening a prefab stage ([95235a9](95235a929b)), closes [#345](https://github.com/mob-sakai/ParticleEffectForUGUI/issues/345)

.github/workflows/release.yml

@@ -38,7 +38,7 @@ jobs:
             @semantic-release/changelog
             @semantic-release/git
         env:
-          GITHUB_TOKEN: ${{ github.token }}
+          GITHUB_TOKEN: ${{ secrets.GH_TOKEN }}
 
       - id: summary
         run: |

.github/workflows/test.yml

@@ -3,29 +3,36 @@
 #   UNITY_EMAIL: Unity user email to login
 #   UNITY_PASSWORD: Unity user password to login
 name: 🧪 Test
-run-name: 🧪 Test (${{ github.ref_name }})
+run-name: 🧪 Test (${{ github.event.pull_request.title || github.ref_name }})
 
 env:
   # MINIMUM_VERSION: The minimum version of Unity.
   MINIMUM_VERSION: 2019.4
   # EXCLUDE_FILTER: The excluded versions of Unity.
-  EXCLUDE_FILTER: '(2020.2.0|2021.1|2023.3)'
+  EXCLUDE_FILTER: "(2020.2.0|2021.1|2023.3)"
 
 on:
   workflow_dispatch:
+    inputs:
+      usePeriodVersions:
+        description: "Use the period versions (.0f1, .10f1, 20f1, ...)."
+        required: false
+        default: "true"
   push:
     branches:
       - develop
       - develop-preview
-      - develop-4.x
     tags:
       - "!*"
     paths-ignore:
-      - "*.md"
+      - "**.md"
-  pull_request:
+  pull_request_target:
     types:
       - opened
+      - reopened
       - synchronize
+    paths-ignore:
+      - "**.md"
 
 jobs:
   setup:
@@ -38,9 +45,12 @@ jobs:
         id: setup
         run: |
           echo "==== Target Unity Versions ===="
-          LATEST_VERSIONS=`npx unity-changeset list --versions --latest-patch --min ${MINIMUM_VERSION} --json --all`
+          LATEST_VERSIONS=`npx unity-changeset@latest list --versions --latest-patch --min ${MINIMUM_VERSION} --json --all`
-          # ADDITIONAL_VERSIONS=`npx unity-changeset list --versions --grep '0f' --min ${MINIMUM_VERSION} --json`
+          if [ "${{ inputs.usePeriodVersions }}" = "true" ]; then
-          ADDITIONAL_VERSIONS=[]
+            ADDITIONAL_VERSIONS=`npx unity-changeset list --versions --grep '0f' --min ${MINIMUM_VERSION} --json`
+          else
+            ADDITIONAL_VERSIONS=[]
+          fi
 
           VERSIONS=`echo "[${LATEST_VERSIONS}, ${ADDITIONAL_VERSIONS}]" \
             | jq -c '[ flatten | sort | unique | .[] | select( test("${{ env.EXCLUDE_FILTER }}") | not ) ]'`
@@ -49,33 +59,44 @@ jobs:
   test:
     name: 🧪 Run tests
     runs-on: ubuntu-latest
-    env:
-      UNITY_EMAIL: ${{ secrets.UNITY_EMAIL }}
-      UNITY_PASSWORD: ${{ secrets.UNITY_PASSWORD }}
-      UNITY_LICENSE: ${{ secrets.UNITY_LICENSE }}
     permissions:
       checks: write
       contents: read
     needs: setup
     strategy:
       fail-fast: false
-      max-parallel: 4
+      max-parallel: 6
       matrix:
         unityVersion: ${{ fromJson(needs.setup.outputs.unityVersions) }}
     steps:
-      - name: 🚚 Checkout
+      - name: 🚚 Checkout ($${{ github.ref }})
+        if: github.event_name == 'push'
         uses: actions/checkout@v4
 
+      - name: 🚚 Checkout pull request (pull_request_target)
+        if: github.event_name == 'pull_request_target'
+        uses: actions/checkout@v4
+        with:
+          ref: ${{ github.event.pull_request.head.sha }}
+          fetch-depth: 0
+
+      - name: 🚚 Marge pull request (pull_request_target)
+        if: github.event_name == 'pull_request_target'
+        run: |
+          git config user.name "GitHub Actions"
+          git config user.email "actions@github.com"
+          git merge origin/${{ github.event.pull_request.base.ref }} --no-edit
+
       - name: 📥 Cache library
         uses: actions/cache@v4
         with:
           path: Library
-          key: Library-${{ matrix.unityVersion }}-${{ github.sha }}
+          key: Library-${{ matrix.unityVersion }}-${{ github.event.pull_request.head.sha || github.sha }}
           restore-keys: |
             Library-${{ matrix.unityVersion }}-
             Library-
 
-      - name: 🛠️ Build Unity Project
+      - name: 🛠️ Build Unity Project (Test)
         uses: game-ci/unity-builder@v4
         timeout-minutes: 45
         with:
@@ -83,6 +104,10 @@ jobs:
           targetPlatform: StandaloneLinux64
           allowDirtyBuild: true
           customParameters: -nographics
+        env:
+          UNITY_EMAIL: ${{ secrets.UNITY_EMAIL }}
+          UNITY_PASSWORD: ${{ secrets.UNITY_PASSWORD }}
+          UNITY_LICENSE: ${{ secrets.UNITY_LICENSE }}
 
       - name: 🧪 Run tests
         uses: game-ci/unity-test-runner@v4
@@ -93,4 +118,7 @@ jobs:
           customParameters: -nographics
           checkName: ${{ matrix.unityVersion }} Test Results
           githubToken: ${{ github.token }}
-          coverageOptions: "dontClear;generateHtmlReport;generateBadgeReport;pathFilters:+**/Packages/src/**;assemblyFilters:+<packages>,-*.Editor,-*.Test"
+        env:
+          UNITY_EMAIL: ${{ secrets.UNITY_EMAIL }}
+          UNITY_PASSWORD: ${{ secrets.UNITY_PASSWORD }}
+          UNITY_LICENSE: ${{ secrets.UNITY_LICENSE }}

Assets/Demo/Cartoon FX & War FX Demo/CFXRF Demo.unity.meta

@@ -0,0 +1,4 @@
+fileFormatVersion: 2
+guid: e34a092899a9547189add96707de1b5a
+DefaultImporter:
+  userData: 

Assets/Demo/Performance Demo/Scripts/UIParticle_PerformanceDemo.cs

@@ -1,3 +1,4 @@
+using Coffee.UIParticleInternal;
 using UnityEngine;
 using UnityEngine.Serialization;
 
@@ -46,11 +47,7 @@ namespace Coffee.UIExtensions.Demo
 
             if (!flag)
             {
-#if UNITY_2023_1_OR_NEWER
+                foreach (var ps in Misc.FindObjectsOfType<ParticleSystem>())
-                foreach (var ps in FindObjectsByType<ParticleSystem>(FindObjectsInactive.Include, FindObjectsSortMode.None))
-#else
-                foreach (var ps in FindObjectsOfType<ParticleSystem>())
-#endif
                 {
                     ps.Play(false);
                 }
@@ -79,11 +76,7 @@ namespace Coffee.UIExtensions.Demo
 
         public void ParticleSystem_SetScale(float scale)
         {
-#if UNITY_2023_1_OR_NEWER
+            foreach (var ps in Misc.FindObjectsOfType<ParticleSystem>())
-            foreach (var ps in FindObjectsByType<ParticleSystem>(FindObjectsInactive.Include, FindObjectsSortMode.None))
-#else
-            foreach (var ps in FindObjectsOfType<ParticleSystem>())
-#endif
             {
                 ps.transform.localScale = new Vector3(scale, scale, scale);
             }

Packages/src/CHANGELOG.md

@@ -1,3 +1,17 @@
+## [4.10.4](https://github.com/mob-sakai/ParticleEffectForUGUI/compare/v4.10.3...v4.10.4) (2024-12-19)
+
+
+### Bug Fixes
+
+* rendering issues when playing with opening a prefab stage ([95235a9](https://github.com/mob-sakai/ParticleEffectForUGUI/commit/95235a929b82cf681365ed6eba837d857f83e3d2)), closes [#345](https://github.com/mob-sakai/ParticleEffectForUGUI/issues/345)
+
+## [4.10.3](https://github.com/mob-sakai/ParticleEffectForUGUI/compare/v4.10.2...v4.10.3) (2024-11-20)
+
+
+### Bug Fixes
+
+* if not configured as a preloaded asset, the project settings asset will be regenerated ([abe0948](https://github.com/mob-sakai/ParticleEffectForUGUI/commit/abe09485f65dd4efd18e74675e752e0213bdf3be)), closes [#342](https://github.com/mob-sakai/ParticleEffectForUGUI/issues/342)
+
 ## [4.10.2](https://github.com/mob-sakai/ParticleEffectForUGUI/compare/v4.10.1...v4.10.2) (2024-11-01)
 
 

Packages/src/Runtime/Internal/Extensions/ComponentExtensions.cs

@@ -134,6 +134,35 @@ namespace Coffee.UIParticleInternal
             Profiler.EndSample();
         }
 
+        /// <summary>
+        /// Add a component of a specific type to the children of a GameObject.
+        /// </summary>
+        public static void AddComponentOnChildren<T>(this Component self, bool includeSelf)
+            where T : Component
+        {
+            if (self == null) return;
+
+            Profiler.BeginSample("(COF)[ComponentExt] AddComponentOnChildren > Self");
+            if (includeSelf && !self.TryGetComponent<T>(out _))
+            {
+                self.gameObject.AddComponent<T>();
+            }
+
+            Profiler.EndSample();
+
+            Profiler.BeginSample("(COF)[ComponentExt] AddComponentOnChildren > Child");
+            var childCount = self.transform.childCount;
+            for (var i = 0; i < childCount; i++)
+            {
+                var child = self.transform.GetChild(i);
+                if (child.TryGetComponent<T>(out _)) continue;
+
+                child.gameObject.AddComponent<T>();
+            }
+
+            Profiler.EndSample();
+        }
+
 #if !UNITY_2021_2_OR_NEWER && !UNITY_2020_3_45 && !UNITY_2020_3_46 && !UNITY_2020_3_47 && !UNITY_2020_3_48
         public static T GetComponentInParent<T>(this Component self, bool includeInactive) where T : Component
         {

Packages/src/Runtime/Internal/Extensions/SpriteExtensions.cs

@@ -17,11 +17,15 @@ namespace Coffee.UIParticleInternal
             Type.GetType("UnityEditor.Experimental.U2D.SpriteEditorExtension, UnityEditor")
             ?? Type.GetType("UnityEditor.U2D.SpriteEditorExtension, UnityEditor");
 
-        private static readonly MethodInfo s_GetActiveAtlasTextureMethod = s_SpriteEditorExtensionType
+        private static readonly Func<Sprite, Texture2D> s_GetActiveAtlasTextureMethod =
-            .GetMethod("GetActiveAtlasTexture", BindingFlags.Static | BindingFlags.NonPublic);
+            (Func<Sprite, Texture2D>)Delegate.CreateDelegate(typeof(Func<Sprite, Texture2D>),
+                s_SpriteEditorExtensionType
+                    .GetMethod("GetActiveAtlasTexture", BindingFlags.Static | BindingFlags.NonPublic));
 
-        private static readonly MethodInfo s_GetActiveAtlasMethod = s_SpriteEditorExtensionType
+        private static readonly Func<Sprite, SpriteAtlas> s_GetActiveAtlasMethod =
-            .GetMethod("GetActiveAtlas", BindingFlags.Static | BindingFlags.NonPublic);
+            (Func<Sprite, SpriteAtlas>)Delegate.CreateDelegate(typeof(Func<Sprite, SpriteAtlas>),
+                s_SpriteEditorExtensionType
+                    .GetMethod("GetActiveAtlas", BindingFlags.Static | BindingFlags.NonPublic));
 
         /// <summary>
         /// Get the actual texture of a sprite in play mode or edit mode.
@@ -30,9 +34,7 @@ namespace Coffee.UIParticleInternal
         {
             if (!self) return null;
 
-            if (Application.isPlaying) return self.texture;
+            var ret = s_GetActiveAtlasTextureMethod(self);
-
-            var ret = s_GetActiveAtlasTextureMethod.Invoke(null, new object[] { self }) as Texture2D;
             return ret ? ret : self.texture;
         }
 
@@ -43,7 +45,7 @@ namespace Coffee.UIParticleInternal
         {
             if (!self) return null;
 
-            return s_GetActiveAtlasMethod.Invoke(null, new object[] { self }) as SpriteAtlas;
+            return s_GetActiveAtlasMethod(self);
         }
 #else
         /// <summary>

Packages/src/Runtime/Internal/ProjectSettings/PreloadedProjectSettings.cs

@@ -1,9 +1,9 @@
 using System;
 using System.Linq;
-using System.Reflection;
 using UnityEngine;
 using Object = UnityEngine.Object;
 #if UNITY_EDITOR
+using System.IO;
 using UnityEditor;
 using UnityEditor.Build;
 using UnityEditor.Build.Reporting;
@@ -14,6 +14,14 @@ namespace Coffee.UIParticleInternal
     public abstract class PreloadedProjectSettings : ScriptableObject
 #if UNITY_EDITOR
     {
+        private class Postprocessor : AssetPostprocessor
+        {
+            private static void OnPostprocessAllAssets(string[] _, string[] __, string[] ___, string[] ____)
+            {
+                Initialize();
+            }
+        }
+
         private class PreprocessBuildWithReport : IPreprocessBuildWithReport
         {
             int IOrderedCallback.callbackOrder => 0;
@@ -24,32 +32,32 @@ namespace Coffee.UIParticleInternal
             }
         }
 
-        [InitializeOnLoadMethod]
-        [InitializeOnEnterPlayMode]
         private static void Initialize()
         {
-            const BindingFlags flags = BindingFlags.Public | BindingFlags.Static | BindingFlags.FlattenHierarchy;
             foreach (var t in TypeCache.GetTypesDerivedFrom(typeof(PreloadedProjectSettings<>)))
             {
                 var defaultSettings = GetDefaultSettings(t);
                 if (!defaultSettings)
                 {
                     // When create a new instance, automatically set it as default settings.
-                    defaultSettings = t.GetProperty("instance", flags)
+                    defaultSettings = CreateInstance(t) as PreloadedProjectSettings;
-                        ?.GetValue(null, null) as PreloadedProjectSettings;
+                    SetDefaultSettings(defaultSettings);
                 }
                 else if (GetPreloadedSettings(t).Length != 1)
                 {
                     SetDefaultSettings(defaultSettings);
                 }
-            }
 
-            EditorApplication.QueuePlayerLoopUpdate();
+                if (defaultSettings)
+                {
+                    defaultSettings.OnInitialize();
+                }
+            }
         }
 
         protected static string GetDefaultName(Type type, bool nicify)
         {
-            var typeName = type.Name.Replace("ProjectSettings", "");
+            var typeName = type.Name;
             return nicify
                 ? ObjectNames.NicifyVariableName(typeName)
                 : typeName;
@@ -74,6 +82,7 @@ namespace Coffee.UIParticleInternal
         protected static void SetDefaultSettings(PreloadedProjectSettings asset)
         {
             if (!asset) return;
+
             var type = asset.GetType();
             if (string.IsNullOrEmpty(AssetDatabase.GetAssetPath(asset)))
             {
@@ -84,7 +93,11 @@ namespace Coffee.UIParticleInternal
 
                 var assetPath = $"Assets/ProjectSettings/{GetDefaultName(type, false)}.asset";
                 assetPath = AssetDatabase.GenerateUniqueAssetPath(assetPath);
-                AssetDatabase.CreateAsset(asset, assetPath);
+                if (!File.Exists(assetPath))
+                {
+                    AssetDatabase.CreateAsset(asset, assetPath);
+                    asset.OnCreateAsset();
+                }
             }
 
             var preloadedAssets = PlayerSettings.GetPreloadedAssets();
@@ -98,6 +111,14 @@ namespace Coffee.UIParticleInternal
 
             AssetDatabase.Refresh();
         }
+
+        protected virtual void OnCreateAsset()
+        {
+        }
+
+        protected virtual void OnInitialize()
+        {
+        }
     }
 #else
     {

Packages/src/Runtime/Internal/Utilities/Misc.cs

@@ -6,6 +6,15 @@ namespace Coffee.UIParticleInternal
 {
     internal static class Misc
     {
+        public static T[] FindObjectsOfType<T>() where T : Object
+        {
+#if UNITY_2023_1_OR_NEWER
+            return Object.FindObjectsByType<T>(FindObjectsInactive.Include, FindObjectsSortMode.None);
+#else
+            return Object.FindObjectsOfType<T>();
+#endif
+        }
+
         public static void Destroy(Object obj)
         {
             if (!obj) return;

Packages/src/Runtime/Internal/Utilities/Misc.cs.meta

@@ -1,5 +1,5 @@
 fileFormatVersion: 2
-guid: 39ed6a6b0a72e482488bd298b2ae762e
+guid: 182319ecc315e4858b119764af0fbcb0
 MonoImporter:
   externalObjects: {}
   serializedVersion: 2

Packages/src/Runtime/Internal/Utilities/UIExtraCallbacks.cs

@@ -14,6 +14,8 @@ namespace Coffee.UIParticleInternal
         private static readonly FastAction s_AfterCanvasRebuildAction = new FastAction();
         private static readonly FastAction s_LateAfterCanvasRebuildAction = new FastAction();
         private static readonly FastAction s_BeforeCanvasRebuildAction = new FastAction();
+        private static readonly FastAction s_OnScreenSizeChangedAction = new FastAction();
+        private static Vector2Int s_LastScreenSize;
 
         static UIExtraCallbacks()
         {
@@ -48,6 +50,15 @@ namespace Coffee.UIParticleInternal
             remove => s_AfterCanvasRebuildAction.Remove(value);
         }
 
+        /// <summary>
+        /// Event that occurs when the screen size changes.
+        /// </summary>
+        public static event Action onScreenSizeChanged
+        {
+            add => s_OnScreenSizeChangedAction.Add(value);
+            remove => s_OnScreenSizeChangedAction.Remove(value);
+        }
+
         /// <summary>
         /// Initializes the UIExtraCallbacks to ensure proper event handling.
         /// </summary>
@@ -77,6 +88,17 @@ namespace Coffee.UIParticleInternal
         /// </summary>
         private static void OnBeforeCanvasRebuild()
         {
+            var screenSize = new Vector2Int(Screen.width, Screen.height);
+            if (s_LastScreenSize != screenSize)
+            {
+                if (s_LastScreenSize != default)
+                {
+                    s_OnScreenSizeChangedAction.Invoke();
+                }
+
+                s_LastScreenSize = screenSize;
+            }
+
             s_BeforeCanvasRebuildAction.Invoke();
             InitializeAfterCanvasRebuild();
         }

Packages/src/Runtime/UIParticle.cs

@@ -9,6 +9,8 @@ using UnityEngine.UI;
 using Random = UnityEngine.Random;
 
 [assembly: InternalsVisibleTo("Coffee.UIParticle.Editor")]
+[assembly: InternalsVisibleTo("Coffee.UIParticle.PerformanceDemo")]
+[assembly: InternalsVisibleTo("Coffee.UIParticle.Demo")]
 
 namespace Coffee.UIExtensions
 {

Packages/src/Samples~/Demo/Scripts/UIParticle_Demo.cs

@@ -1,3 +1,4 @@
+using Coffee.UIParticleInternal;
 using UnityEngine;
 using UnityEngine.Serialization;
 using UnityEngine.UI;
@@ -51,11 +52,7 @@ namespace Coffee.UIExtensions.Demo
 
         public void EnableAnimations(bool flag)
         {
-#if UNITY_2023_1_OR_NEWER
+            foreach (var animator in Misc.FindObjectsOfType<Animator>())
-            foreach (var animator in FindObjectsByType<Animator>(FindObjectsInactive.Include, FindObjectsSortMode.None))
-#else
-            foreach (var animator in FindObjectsOfType<Animator>())
-#endif
             {
                 animator.enabled = flag;
             }
@@ -83,11 +80,7 @@ namespace Coffee.UIExtensions.Demo
 
         public void UIParticle_Scale(float scale)
         {
-#if UNITY_2023_1_OR_NEWER
+            foreach (var uip in Misc.FindObjectsOfType<UIParticle>())
-            foreach (var uip in FindObjectsByType<UIParticle>(FindObjectsInactive.Include, FindObjectsSortMode.None))
-#else
-            foreach (var uip in FindObjectsOfType<UIParticle>())
-#endif
             {
                 uip.scale = scale;
             }
@@ -95,11 +88,7 @@ namespace Coffee.UIExtensions.Demo
 
         public void ParticleSystem_WorldSpaseSimulation(bool flag)
         {
-#if UNITY_2023_1_OR_NEWER
+            foreach (var p in Misc.FindObjectsOfType<ParticleSystem>())
-            foreach (var p in FindObjectsByType<ParticleSystem>(FindObjectsInactive.Include, FindObjectsSortMode.None))
-#else
-            foreach (var p in FindObjectsOfType<ParticleSystem>())
-#endif
             {
                 var main = p.main;
                 main.simulationSpace = flag
@@ -135,11 +124,7 @@ namespace Coffee.UIExtensions.Demo
 
         public void ParticleSystem_SetScale(float scale)
         {
-#if UNITY_2023_1_OR_NEWER
+            foreach (var ps in Misc.FindObjectsOfType<ParticleSystem>())
-            foreach (var ps in FindObjectsByType<ParticleSystem>(FindObjectsInactive.Include, FindObjectsSortMode.None))
-#else
-            foreach (var ps in FindObjectsOfType<ParticleSystem>())
-#endif
             {
                 ps.transform.localScale = new Vector3(scale, scale, scale);
             }

Packages/src/package.json

@@ -2,7 +2,7 @@
   "name": "com.coffee.ui-particle",
   "displayName": "UI Particle",
   "description": "This package provides a component to render particle effects for uGUI.\nThe particle rendering is maskable and sortable, without the need for an extra Camera, RenderTexture, or Canvas.",
-  "version": "4.10.2",
+  "version": "4.10.4",
   "unity": "2018.2",
   "license": "MIT",
   "repository": {