chore(release): 5.0.0-preview.11 [skip ci]

# [5.0.0-preview.11](https://github.com/mob-sakai/ParticleEffectForUGUI/compare/v5.0.0-preview.10...v5.0.0-preview.11) (2024-09-29)

### Features

* change the default value of `UIParticle.scale` from `10` to `1` ([4e188dd](4e188dd39e))
* UIParticle no longer inherits from MaskableGraphic ([52eb28c](52eb28cdaf))

### BREAKING CHANGES

* Some members inherited from MaskableGraphic will no longer be available.

.github/workflows/release.yml

@@ -1,12 +1,12 @@
 name: 🔖 Release
+run-name: 🔖 Release (${{ github.ref_name }})
 
 on:
   workflow_dispatch:
   push:
     branches:
       - release
-      - release-preview
+      - release-*
-      - release-v4
     tags-ignore:
       - "**"
 
@@ -50,14 +50,12 @@ jobs:
           if [ '${{ steps.release.outputs.new_release_published }}' = 'false' ]; then
             echo "No new release published." | tee -a $GITHUB_STEP_SUMMARY
           elif [ '${{ github.ref_name }}' = 'release' ]; then
-            echo "merge_to=develop" | tee -a $GITHUB_OUTPUT
+            echo "merge_to=develop" | tee -a $GITHUB_OUTPUT $GITHUB_STEP_SUMMARY
-            echo "split_to=main" | tee -a $GITHUB_OUTPUT
+            echo "split_to=main" | tee -a $GITHUB_OUTPUT $GITHUB_STEP_SUMMARY
-          elif [ '${{ github.ref_name }}' = 'release-preview' ]; then
+          else
-            echo "merge_to=develop-preview" | tee -a $GITHUB_OUTPUT
+            channel=$(echo ${{ github.ref_name }} | sed 's/^release-//')
-            echo "split_to=preview" | tee -a $GITHUB_OUTPUT
+            echo "merge_to=develop-${channel}" | tee -a $GITHUB_OUTPUT $GITHUB_STEP_SUMMARY
-          elif [ '${{ github.ref_name }}' = 'release-4.x' ]; then
+            echo "split_to=${channel}" | tee -a $GITHUB_OUTPUT $GITHUB_STEP_SUMMARY
-            echo "merge_to=develop-4.x" | tee -a $GITHUB_OUTPUT
-            echo "split_to=4.x" | tee -a $GITHUB_OUTPUT
           fi
 
   merge-to:

.github/workflows/test.yml

@@ -3,12 +3,13 @@
 #   UNITY_EMAIL: Unity user email to login
 #   UNITY_PASSWORD: Unity user password to login
 name: 🧪 Test
+run-name: 🧪 Test (${{ 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)'
+  EXCLUDE_FILTER: '(2020.2.0|2021.1|2023.3)'
 
 on:
   workflow_dispatch:

Assets/Demo/Cartoon FX & War FX Demo/CFX_Demo_With_UIParticle.cs

@@ -80,7 +80,11 @@ namespace Coffee.UIExtensions.Demo
                 .SelectMany(x => x.GetTypes())
                 .FirstOrDefault(x => x.Name == typeName);
 
+#if UNITY_2023_2_OR_NEWER
+            return type == null ? null : FindFirstObjectByType(type);
+#else
             return type == null ? null : FindObjectOfType(type);
+#endif
         }
 
         public void SetCanvasWidth(int width)

Assets/ProjectSettings/UIParticle.asset

@@ -12,4 +12,5 @@ MonoBehaviour:
   m_Script: {fileID: 11500000, guid: f22a23b9d98e440478697f4adf30e61c, type: 3}
   m_Name: UIParticle
   m_EditorClassIdentifier: 
-  m_LinearToGamma: 1
+  m_EnableLinearToGamma: 1
+  m_HideGeneratedObjects: 1

Assets/ProjectSettings/UIParticle.asset.meta

@@ -1,5 +1,5 @@
 fileFormatVersion: 2
-guid: e8e7744b163af4869b07b8f192c810ed
+guid: 4b9df7b8a4193489299b8f477348ae0c
 NativeFormatImporter:
   externalObjects: {}
   mainObjectFileID: 11400000

Packages/manifest.json

@@ -1,9 +1,8 @@
 {
   "dependencies": {
-    "com.unity.ide.rider": "3.0.31",
     "com.coffee.development": "https://github.com/mob-sakai/Coffee.Internal.git?path=Packages/Development",
     "com.coffee.nano-monitor": "https://github.com/mob-sakai/Coffee.Internal.git?path=Packages/NanoMonitor",
-    "com.coffee.sub-asset-editor": "https://github.com/mob-sakai/SubAssetEditor.git",
+    "com.unity.ide.rider": "3.0.31",
     "com.unity.test-framework": "1.1.33",
     "com.unity.modules.animation": "1.0.0",
     "com.unity.modules.physics": "1.0.0"

Packages/packages-lock.json

@@ -5,7 +5,7 @@
       "depth": 0,
       "source": "git",
       "dependencies": {},
-      "hash": "c51e4514c9ab944915a639433ee52342e55a644e"
+      "hash": "4e5f735ccf956ee469b5014ae781068c49a2825d"
     },
     "com.coffee.nano-monitor": {
       "version": "https://github.com/mob-sakai/Coffee.Internal.git?path=Packages/NanoMonitor",
@@ -14,14 +14,7 @@
       "dependencies": {
         "com.unity.ugui": "1.0.0"
       },
-      "hash": "c51e4514c9ab944915a639433ee52342e55a644e"
+      "hash": "4e5f735ccf956ee469b5014ae781068c49a2825d"
-    },
-    "com.coffee.sub-asset-editor": {
-      "version": "https://github.com/mob-sakai/SubAssetEditor.git",
-      "depth": 0,
-      "source": "git",
-      "dependencies": {},
-      "hash": "01464178eec1e4dbe741c11c9baeb94a151c99ee"
     },
     "com.coffee.ui-particle": {
       "version": "file:src",

Packages/src/CHANGELOG.md

@@ -1,3 +1,42 @@
+# [5.0.0-preview.11](https://github.com/mob-sakai/ParticleEffectForUGUI/compare/v5.0.0-preview.10...v5.0.0-preview.11) (2024-09-29)
+
+
+### Features
+
+* change the default value of `UIParticle.scale` from `10` to `1` ([4e188dd](https://github.com/mob-sakai/ParticleEffectForUGUI/commit/4e188dd39ee32dd1339066a6946e43ba3580c324))
+* UIParticle no longer inherits from MaskableGraphic ([52eb28c](https://github.com/mob-sakai/ParticleEffectForUGUI/commit/52eb28cdafe7c9009d5a4b76978e002798440e8d))
+
+
+### BREAKING CHANGES
+
+* Some members inherited from MaskableGraphic will no longer be available.
+
+## [4.10.1](https://github.com/mob-sakai/ParticleEffectForUGUI/compare/v4.10.0...v4.10.1) (2024-09-29)
+
+
+### Bug Fixes
+
+* mainTex will be ignored ([2ee69d0](https://github.com/mob-sakai/ParticleEffectForUGUI/commit/2ee69d04245fabce185f67dc9bd68c870e556564))
+
+# [4.10.0](https://github.com/mob-sakai/ParticleEffectForUGUI/compare/v4.9.1...v4.10.0) (2024-09-29)
+
+
+### Bug Fixes
+
+* component icon is not set ([5ff6ec8](https://github.com/mob-sakai/ParticleEffectForUGUI/commit/5ff6ec815a174de5d3f16d424f1204c60912a8d8))
+
+
+### Features
+
+* add project settings ([1ce4e31](https://github.com/mob-sakai/ParticleEffectForUGUI/commit/1ce4e31a9681bf1a201d2723c8d97e07ecc16592))
+
+## [4.9.1](https://github.com/mob-sakai/ParticleEffectForUGUI/compare/v4.9.0...v4.9.1) (2024-08-07)
+
+
+### Bug Fixes
+
+* ParticleSystem trails gain offset on parent canvas change ([2a1cd50](https://github.com/mob-sakai/ParticleEffectForUGUI/commit/2a1cd502b452b5b56edf8bcfe91adf99d1bb5147)), closes [#323](https://github.com/mob-sakai/ParticleEffectForUGUI/issues/323)
+
 # [4.9.0](https://github.com/mob-sakai/ParticleEffectForUGUI/compare/v4.8.1...v4.9.0) (2024-07-18)
 
 

Packages/src/Editor/UIParticleEditor.cs

@@ -6,16 +6,14 @@ using UnityEditorInternal;
 using UnityEngine;
 using UnityEngine.Profiling;
 using UnityEngine.UI;
-
+using Coffee.UIParticleInternal;
 #if UNITY_2021_2_OR_NEWER
 using UnityEditor.Overlays;
 #else
 using System;
 using System.Reflection;
-using Coffee.UIParticleInternal;
 using Object = UnityEngine.Object;
 #endif
-
 #if UNITY_2021_2_OR_NEWER
 using UnityEditor.SceneManagement;
 
@@ -436,7 +434,11 @@ namespace Coffee.UIExtensions
         {
             if (!p || (ignoreCurrent && target == p)) return;
 
-            DestroyImmediate(p);
+            Misc.DestroyImmediate(p);
+            if (p.TryGetComponent<CanvasRenderer>(out var cr))
+            {
+                Misc.DestroyImmediate(cr);
+            }
 
 #if UNITY_2018_3_OR_NEWER
             var stage = PrefabStageUtility.GetCurrentPrefabStage();

Packages/src/README.md

@@ -36,6 +36,7 @@ You can render, mask, and sort your `ParticleSystems` for UI without the need fo
   - [Usage with `Mask` or `RectMask2D` Component](#usage-with-mask-or-rectmask2d-component)
   - [Usage with Script](#usage-with-script)
   - [Component: UIParticleAttractor](#component-uiparticleattractor)
+  - [Project Settings](#project-settings)
 - [🛠 Development Note](#-development-note)
   - [Compares the Baking mesh approach with the conventional approach](#compares-the-baking-mesh-approach-with-the-conventional-approach)
     - [Performance test results](#performance-test-results)
@@ -269,6 +270,14 @@ uiParticle.Stop();
 
 <br><br>
 
+### Project Settings
+
+![](https://github.com/user-attachments/assets/befc7f34-fb47-4006-831a-eba79fda11ca)
+
+- Click `Edit > Project Settings` to open the Project Settings window and then select `UI > UI Particle` category.
+
+<br><br>
+
 ## 🛠 Development Note
 
 ### Compares the Baking mesh approach with the conventional approach

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

@@ -1,19 +0,0 @@
-using System.Collections.Generic;
-
-namespace Coffee.UIParticleInternal
-{
-    /// <summary>
-    /// Extension methods for Component class.
-    /// </summary>
-    internal static class ListExtensions
-    {
-        public static void RemoveAtFast<T>(this List<T> self, int index)
-        {
-            if (self == null) return;
-
-            var lastIndex = self.Count - 1;
-            self[index] = self[lastIndex];
-            self.RemoveAt(lastIndex);
-        }
-    }
-}

Packages/src/Runtime/Internal/Extensions/ListExtensions.cs.meta

@@ -1,11 +0,0 @@
-fileFormatVersion: 2
-guid: 833553390099d40c9b212823f0852c46
-MonoImporter:
-  externalObjects: {}
-  serializedVersion: 2
-  defaultReferences: []
-  executionOrder: 0
-  icon: {instanceID: 0}
-  userData: 
-  assetBundleName: 
-  assetBundleVariant: 

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

@@ -34,9 +34,9 @@ namespace Coffee.UIParticleInternal
                 var defaultSettings = GetDefaultSettings(t);
                 if (!defaultSettings)
                 {
+                    // When create a new instance, automatically set it as default settings.
                     defaultSettings = t.GetProperty("instance", flags)
                         ?.GetValue(null, null) as PreloadedProjectSettings;
-                    SetDefaultSettings(defaultSettings);
                 }
                 else if (GetPreloadedSettings(t).Length != 1)
                 {
@@ -73,6 +73,7 @@ namespace Coffee.UIParticleInternal
 
         protected static void SetDefaultSettings(PreloadedProjectSettings asset)
         {
+            if (!asset) return;
             var type = asset.GetType();
             if (string.IsNullOrEmpty(AssetDatabase.GetAssetPath(asset)))
             {
@@ -103,7 +104,6 @@ namespace Coffee.UIParticleInternal
     }
 #endif
 
-
     public abstract class PreloadedProjectSettings<T> : PreloadedProjectSettings
         where T : PreloadedProjectSettings<T>
     {

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

@@ -46,7 +46,6 @@ namespace Coffee.UIParticleInternal
             GetFrameCache<T>().Set((key1.GetHashCode(), key2.GetHashCode()), result);
         }
 
-
         /// <summary>
         /// Sets a value in the frame cache with a specified key.
         /// </summary>

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

@@ -5,7 +5,6 @@ using Object = UnityEngine.Object;
 #if ENABLE_COFFEE_LOGGER
 using System.Reflection;
 using System.Collections.Generic;
-
 #else
 using Conditional = System.Diagnostics.ConditionalAttribute;
 #endif
@@ -43,7 +42,6 @@ namespace Coffee.UIParticleInternal
 #endif
         }
 
-
 #if !ENABLE_COFFEE_LOGGER
         [Conditional(k_DisableSymbol)]
 #endif
@@ -53,7 +51,6 @@ namespace Coffee.UIParticleInternal
             Log_Internal(LogType.Log, tag, message, context ? context : tag as Object);
         }
 
-
 #if !ENABLE_COFFEE_LOGGER
         [Conditional(k_DisableSymbol)]
 #endif
@@ -62,7 +59,6 @@ namespace Coffee.UIParticleInternal
             Log_Internal(LogType.Log, tag, message, context ? context : tag as Object);
         }
 
-
 #if !ENABLE_COFFEE_LOGGER
         [Conditional(k_DisableSymbol)]
 #endif
@@ -80,7 +76,6 @@ namespace Coffee.UIParticleInternal
 #endif
         }
 
-
 #if !ENABLE_COFFEE_LOGGER
         [Conditional(k_DisableSymbol)]
 #endif
@@ -124,7 +119,6 @@ namespace Coffee.UIParticleInternal
 #endif
         }
 
-
 #if !ENABLE_COFFEE_LOGGER
         [Conditional(k_DisableSymbol)]
 #endif
@@ -170,7 +164,6 @@ namespace Coffee.UIParticleInternal
 #endif
         }
 
-
 #if !ENABLE_COFFEE_LOGGER
         [Conditional(k_DisableSymbol)]
 #endif
@@ -209,7 +202,6 @@ namespace Coffee.UIParticleInternal
 #endif
         }
 
-
 #if !ENABLE_COFFEE_LOGGER
         [Conditional(k_DisableSymbol)]
 #endif

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

@@ -55,7 +55,6 @@ namespace Coffee.UIParticleInternal
             Profiler.EndSample();
         }
 
-
         /// <summary>
         /// Adds or retrieves a cached material based on the hash.
         /// </summary>

Packages/src/Runtime/UIParticle.cs

@@ -763,7 +763,7 @@ namespace Coffee.UIExtensions
             _bakeCamera.useOcclusionCulling = false;
 
             _bakeCamera.gameObject.SetActive(false);
-            _bakeCamera.gameObject.hideFlags = HideFlags.HideAndDontSave;
+            _bakeCamera.gameObject.hideFlags = UIParticleProjectSettings.globalHideFlags;
 
             return _bakeCamera;
         }

Packages/src/Runtime/UIParticleAttractor.cs

@@ -148,7 +148,7 @@ namespace Coffee.UIExtensions
             // Collect UIParticle if needed (same size as m_ParticleSystems)
             CollectUIParticlesIfNeeded();
 
-            for (var particleIndex = 0; particleIndex < this.m_ParticleSystems.Count; particleIndex++)
+            for (var particleIndex = 0; particleIndex < m_ParticleSystems.Count; particleIndex++)
             {
                 var particleSystem = m_ParticleSystems[particleIndex];
 
@@ -163,21 +163,21 @@ namespace Coffee.UIExtensions
                 particleSystem.GetParticles(particles, count);
 
                 var uiParticle = _uiParticles[particleIndex];
-                var dstPos = this.GetDestinationPosition(uiParticle, particleSystem);
+                var dstPos = GetDestinationPosition(uiParticle, particleSystem);
                 for (var i = 0; i < count; i++)
                 {
                     // Attracted
                     var p = particles[i];
-                    if (0f < p.remainingLifetime && Vector3.Distance(p.position, dstPos) < this.m_DestinationRadius)
+                    if (0f < p.remainingLifetime && Vector3.Distance(p.position, dstPos) < m_DestinationRadius)
                     {
                         p.remainingLifetime = 0f;
                         particles[i] = p;
 
-                        if (this.m_OnAttracted != null)
+                        if (m_OnAttracted != null)
                         {
                             try
                             {
-                                this.m_OnAttracted.Invoke();
+                                m_OnAttracted.Invoke();
                             }
                             catch (Exception e)
                             {
@@ -189,7 +189,7 @@ namespace Coffee.UIExtensions
                     }
 
                     // Calc attracting time
-                    var delayTime = p.startLifetime * this.m_DelayRate;
+                    var delayTime = p.startLifetime * m_DelayRate;
                     var duration = p.startLifetime - delayTime;
                     var time = Mathf.Max(0, p.startLifetime - p.remainingLifetime - delayTime);
 
@@ -197,7 +197,7 @@ namespace Coffee.UIExtensions
                     if (time <= 0) continue;
 
                     // Attract
-                    p.position = this.GetAttractedPosition(p.position, dstPos, duration, time);
+                    p.position = GetAttractedPosition(p.position, dstPos, duration, time);
                     p.velocity *= 0.5f;
                     particles[i] = p;
                 }

Packages/src/Runtime/UIParticleAttractor.cs.meta

@@ -5,7 +5,7 @@ MonoImporter:
   serializedVersion: 2
   defaultReferences: []
   executionOrder: 0
-  icon: {instanceID: 0}
+  icon: {fileID: 2800000, guid: 5f0675613942149309588d556e33d990, type: 3}
   userData: 
   assetBundleName: 
   assetBundleVariant: 

Packages/src/Runtime/UIParticleProjectSettings.cs

@@ -17,6 +17,18 @@ namespace Coffee.UIExtensions
             set => instance.m_EnableLinearToGamma = value;
         }
 
+
+        [Header("Editor")]
+        [Tooltip("Hide the automatically generated objects.\n" +
+                 "  - UIParticleRenderer\n" +
+                 "  - UIParticle BakingCamera")]
+        [SerializeField]
+        private bool m_HideGeneratedObjects = true;
+
+        public static HideFlags globalHideFlags => instance.m_HideGeneratedObjects
+            ? HideFlags.DontSave | HideFlags.NotEditable | HideFlags.HideInHierarchy | HideFlags.HideInInspector
+            : HideFlags.DontSave | HideFlags.NotEditable;
+
 #if UNITY_EDITOR
         [SettingsProvider]
         private static SettingsProvider CreateSettingsProvider()

Packages/src/Runtime/UIParticleProjectSettings.cs.meta

@@ -5,7 +5,7 @@ MonoImporter:
   serializedVersion: 2
   defaultReferences: []
   executionOrder: 0
-  icon: {instanceID: 0}
+  icon: {fileID: 2800000, guid: 5f0675613942149309588d556e33d990, type: 3}
   userData: 
   assetBundleName: 
   assetBundleVariant: 

Packages/src/Runtime/UIParticleRenderer.cs

@@ -4,7 +4,6 @@
 #elif UNITY_2022_3_OR_NEWER
 #define PS_BAKE_API_V2
 #endif
-
 using System;
 using System.Collections.Generic;
 using Coffee.UIParticleInternal;
@@ -137,6 +136,7 @@ namespace Coffee.UIExtensions
         {
             base.OnEnable();
 
+            hideFlags = UIParticleProjectSettings.globalHideFlags;
             if (!s_CombineInstances[0].mesh)
             {
                 s_CombineInstances[0].mesh = new Mesh
@@ -161,7 +161,7 @@ namespace Coffee.UIExtensions
             // Create renderer object.
             var go = new GameObject("[generated] UIParticleRenderer", typeof(UIParticleRenderer))
             {
-                hideFlags = HideFlags.HideAndDontSave,
+                hideFlags = UIParticleProjectSettings.globalHideFlags,
                 layer = parent.gameObject.layer
             };
 
@@ -201,7 +201,6 @@ namespace Coffee.UIExtensions
                 return modifiedMaterial;
             }
 
-            //
             var hash = new Hash128(
                 modifiedMaterial ? (uint)modifiedMaterial.GetInstanceID() : 0,
                 texture ? (uint)texture.GetInstanceID() : 0,
@@ -424,13 +423,12 @@ namespace Coffee.UIExtensions
 
                 var components = ListPool<Component>.Rent();
                 GetComponents(typeof(IMeshModifier), components);
-
-#pragma warning disable CS0618 // Type or member is obsolete
                 for (var i = 0; i < components.Count; i++)
                 {
+#pragma warning disable CS0618 // Type or member is obsolete
                     ((IMeshModifier)components[i]).ModifyMesh(workerMesh);
-                }
 #pragma warning restore CS0618 // Type or member is obsolete
+                }
 
                 ListPool<Component>.Return(ref components);
             }

Packages/src/Runtime/UIParticleRenderer.cs.meta

@@ -5,7 +5,7 @@ MonoImporter:
   serializedVersion: 2
   defaultReferences: []
   executionOrder: 0
-  icon: {instanceID: 0}
+  icon: {fileID: 2800000, guid: 5f0675613942149309588d556e33d990, type: 3}
   userData: 
   assetBundleName: 
   assetBundleVariant: 

Packages/src/Shaders/UIAdditive.shader

@@ -40,7 +40,10 @@
         Lighting Off
         ZWrite Off
         ZTest [unity_GUIZTestMode]
-        Fog { Mode Off }
+        Fog
+        {
+            Mode Off
+        }
         Blend One One
 
         ColorMask [_ColorMask]
@@ -61,21 +64,21 @@
 
             struct appdata_t
             {
-                float4 vertex   : POSITION;
+                float4 vertex : POSITION;
-                float4 color    : COLOR;
+                float4 color : COLOR;
                 float2 texcoord : TEXCOORD0;
                 UNITY_VERTEX_INPUT_INSTANCE_ID
             };
 
             struct v2f
             {
-                float4 vertex           : SV_POSITION;
+                float4 vertex : SV_POSITION;
-                fixed4 color            : COLOR;
+                fixed4 color : COLOR;
-                float2 texcoord         : TEXCOORD0;
+                float2 texcoord : TEXCOORD0;
-                float4 worldPosition    : TEXCOORD1;
+                float4 worldPosition : TEXCOORD1;
                 UNITY_VERTEX_OUTPUT_STEREO
             };
-            
+
             fixed4 _Color;
             sampler2D _MainTex;
             float4 _MainTex_ST;
@@ -114,4 +117,4 @@
             ENDCG
         }
     }
-}
+}

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.9.0",
+  "version": "5.0.0-preview.11",
   "unity": "2018.2",
   "license": "MIT",
   "repository": {

ProjectSettings/ProjectSettings.asset

@@ -124,7 +124,7 @@ PlayerSettings:
   bundleVersion: 1.0
   preloadedAssets:
   - {fileID: 11400000, guid: 86087a0847f384b538391745dad4565c, type: 2}
-  - {fileID: 11400000, guid: e8e7744b163af4869b07b8f192c810ed, type: 2}
+  - {fileID: 11400000, guid: 4b9df7b8a4193489299b8f477348ae0c, type: 2}
   metroInputSource: 0
   wsaTransparentSwapchain: 0
   m_HolographicPauseOnTrackingLoss: 1