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

# [5.0.0-preview.1](https://github.com/mob-sakai/ParticleEffectForUGUI/compare/v4.6.6...v5.0.0-preview.1) (2024-05-23)

### Features

* add project settings for UIParticle ([b6e6185](b6e6185c52))
* change the default value of `UIParticle.scale` from `10` to `1` ([1b3c0f9](1b3c0f92dc)), closes [#310](https://github.com/mob-sakai/ParticleEffectForUGUI/issues/310)
* UIParticle no longer inherits from MaskableGraphic ([b6d921b](b6d921b3e4))

### BREAKING CHANGES

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

.github/workflows/release.yml

@@ -4,8 +4,9 @@ on:
   workflow_dispatch:
   push:
     branches:
-      - preview
       - release
+      - release-preview
+      - release-v4
     tags-ignore:
       - "**"
 
@@ -22,7 +23,8 @@ jobs:
       released: ${{ steps.release.outputs.new_release_published }}
       tag: ${{ steps.release.outputs.new_release_git_tag }}
       version: ${{ steps.release.outputs.new_release_version }}
-      notes: ${{ steps.release.outputs.new_release_notes }}
+      merge_to: ${{ steps.summary.outputs.merge_to }}
+      split_to: ${{ steps.summary.outputs.split_to }}
     steps:
       - name: 🚚 Checkout (${{ github.ref_name }})
         uses: actions/checkout@v4
@@ -38,37 +40,51 @@ jobs:
         env:
           GITHUB_TOKEN: ${{ github.token }}
 
-      - run: |
+      - id: summary
+        run: |
           echo "🔖 New release published: '${{ steps.release.outputs.new_release_published }}'" | tee -a $GITHUB_STEP_SUMMARY
           echo "🔖 New release version: '${{ steps.release.outputs.new_release_version }}'" | tee -a $GITHUB_STEP_SUMMARY
           echo "🔖 New release channel: '${{ steps.release.outputs.new_release_channel }}'" | tee -a $GITHUB_STEP_SUMMARY
           echo "🔖 New release git tag: '${{ steps.release.outputs.new_release_git_tag }}'" | tee -a $GITHUB_STEP_SUMMARY
+          
+          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 "split_to=main" | tee -a $GITHUB_OUTPUT
+          elif [ '${{ github.ref_name }}' = 'release-preview' ]; then
+            echo "merge_to=develop-preview" | tee -a $GITHUB_OUTPUT
+            echo "split_to=preview" | tee -a $GITHUB_OUTPUT
+          elif [ '${{ github.ref_name }}' = 'release-4.x' ]; then
+            echo "merge_to=develop-4.x" | tee -a $GITHUB_OUTPUT
+            echo "split_to=4.x" | tee -a $GITHUB_OUTPUT
+          fi
 
-  merge-to-develop:
-    if: needs.release.outputs.released == 'true'
+  merge-to:
+    if: needs.release.outputs.merge_to != ''
     needs: release
-    name: 🔀 Merge to develop
+    name: 🔀 Merge to ${{ needs.release.outputs.merge_to }}
     runs-on: ubuntu-latest
     permissions:
       contents: write
     steps:
-      - name: 🚚 Checkout (develop)
+      - name: 🚚 Checkout (${{ needs.release.outputs.merge_to }})
         uses: actions/checkout@v4
         with:
-          ref: develop
+          ref: ${{ needs.release.outputs.merge_to }}
           fetch-depth: 0
-      - name: 🔀 Merge '${{ needs.release.outputs.tag }}' into 'develop'
+      - name: 🔀 Merge '${{ needs.release.outputs.tag }}' into '${{ needs.release.outputs.merge_to }}'
         run: |
           git config --local user.email "github-actions[bot]@users.noreply.github.com"
           git config --local user.name "github-actions[bot]"
           
           git merge ${{ needs.release.outputs.tag }}
-          git push origin develop
+          git push origin ${{ needs.release.outputs.merge_to }}
 
-  split-to-main:
-    if: needs.release.outputs.released == 'true'
+  split-to:
+    if: needs.release.outputs.split_to != ''
     needs: release
-    name: 🔀 Split package
+    name: 🔀 Split package to ${{ needs.release.outputs.split_to }}
     runs-on: ubuntu-latest
     permissions:
       contents: write
@@ -78,9 +94,10 @@ jobs:
         with:
           ref: ${{ needs.release.outputs.tag }}
           fetch-depth: 0
-      - name: 🔀 Split subtree 'Packages/src' to 'main'
+      - name: 🔀 Split subtree 'Packages/src' to '${{ needs.release.outputs.split_to }}'
         run: |
-          git branch main origin/main
-          git subtree split --prefix=Packages/src --branch main
-          git tag ${{ needs.release.outputs.version }} main
-          git push origin ${{ needs.release.outputs.version }} main:main
+          split_to=${{ needs.release.outputs.split_to }}
+          git branch $split_to origin/$split_to
+          git subtree split --prefix=Packages/src --branch $split_to
+          git tag ${{ needs.release.outputs.version }} $split_to
+          git push origin ${{ needs.release.outputs.version }} $split_to:$split_to

.github/workflows/test.yml

@@ -15,7 +15,8 @@ on:
   push:
     branches:
       - develop
-      - develop_v5
+      - develop-preview
+      - develop-4.x
     tags:
       - "!*"
     paths-ignore:

Assets/ProjectSettings/UIParticle.asset

@@ -0,0 +1,15 @@
+%YAML 1.1
+%TAG !u! tag:unity3d.com,2011:
+--- !u!114 &11400000
+MonoBehaviour:
+  m_ObjectHideFlags: 0
+  m_CorrespondingSourceObject: {fileID: 0}
+  m_PrefabInstance: {fileID: 0}
+  m_PrefabAsset: {fileID: 0}
+  m_GameObject: {fileID: 0}
+  m_Enabled: 1
+  m_EditorHideFlags: 0
+  m_Script: {fileID: 11500000, guid: f22a23b9d98e440478697f4adf30e61c, type: 3}
+  m_Name: UIParticle
+  m_EditorClassIdentifier: 
+  m_LinearToGamma: 1

Assets/ProjectSettings/UIParticle.asset.meta

@@ -1,8 +1,8 @@
 fileFormatVersion: 2
-guid: 269bcefd175184eebbfa31421171fadf
-folderAsset: yes
-DefaultImporter:
+guid: e8e7744b163af4869b07b8f192c810ed
+NativeFormatImporter:
   externalObjects: {}
+  mainObjectFileID: 11400000
   userData: 
   assetBundleName: 
   assetBundleVariant: 

Packages/packages-lock.json

@@ -5,7 +5,7 @@
       "depth": 0,
       "source": "git",
       "dependencies": {},
-      "hash": "41a1b604af8769b600d9c75db02ff35ec30611dc"
+      "hash": "4a57c0a498ba7ce667290ec39510b1474030471a"
     },
     "com.coffee.nano-monitor": {
       "version": "https://github.com/mob-sakai/Coffee.Internal.git?path=Packages/NanoMonitor",
@@ -14,7 +14,7 @@
       "dependencies": {
         "com.unity.ugui": "1.0.0"
       },
-      "hash": "41a1b604af8769b600d9c75db02ff35ec30611dc"
+      "hash": "4a57c0a498ba7ce667290ec39510b1474030471a"
     },
     "com.coffee.simple-scene-navigator": {
       "version": "https://github.com/mob-sakai/Coffee.Internal.git?path=Packages/SceneNavigator",
@@ -23,7 +23,7 @@
       "dependencies": {
         "com.unity.ugui": "1.0.0"
       },
-      "hash": "41a1b604af8769b600d9c75db02ff35ec30611dc"
+      "hash": "4a57c0a498ba7ce667290ec39510b1474030471a"
     },
     "com.coffee.sub-asset-editor": {
       "version": "https://github.com/mob-sakai/SubAssetEditor.git",

Packages/src/.releaserc.json

@@ -1,9 +1,10 @@
 {
   "branches": [
     "release",
+    "release-4.x",
     {
-      "name": "preview",
-      "prerelease": true
+      "name": "release-preview",
+      "prerelease": "preview"
     }
   ],
   "plugins": [

Packages/src/CHANGELOG.md

@@ -1,3 +1,31 @@
+# [5.0.0-preview.1](https://github.com/mob-sakai/ParticleEffectForUGUI/compare/v4.6.6...v5.0.0-preview.1) (2024-05-23)
+
+
+### Features
+
+* add project settings for UIParticle ([b6e6185](https://github.com/mob-sakai/ParticleEffectForUGUI/commit/b6e6185c521fef0f118f61cfdfdac07b87555c01))
+* change the default value of `UIParticle.scale` from `10` to `1` ([1b3c0f9](https://github.com/mob-sakai/ParticleEffectForUGUI/commit/1b3c0f92dcc6a1974d1ea074821e5264200e9711)), closes [#310](https://github.com/mob-sakai/ParticleEffectForUGUI/issues/310)
+* UIParticle no longer inherits from MaskableGraphic ([b6d921b](https://github.com/mob-sakai/ParticleEffectForUGUI/commit/b6d921b3e47f749b5028d22b0e89b6eb3a1af7de))
+
+
+### BREAKING CHANGES
+
+* Some members inherited from MaskableGraphic will no longer be available.
+
+## [4.6.6](https://github.com/mob-sakai/ParticleEffectForUGUI/compare/v4.6.5...v4.6.6) (2024-05-23)
+
+
+### Bug Fixes
+
+* fix release workflow ([30b0076](https://github.com/mob-sakai/ParticleEffectForUGUI/commit/30b00762f6da166c043587798b1552f27b4cc604))
+
+## [4.6.5](https://github.com/mob-sakai/ParticleEffectForUGUI/compare/v4.6.4...v4.6.5) (2024-05-23)
+
+
+### Bug Fixes
+
+* update workflows (for preview and v4) ([3eab097](https://github.com/mob-sakai/ParticleEffectForUGUI/commit/3eab0979b9b85919b804442ab05735b7120eade5))
+
 ## [4.6.4](https://github.com/mob-sakai/ParticleEffectForUGUI/compare/v4.6.3...v4.6.4) (2024-05-22)
 
 

Packages/src/Editor/AssetModification.meta

@@ -1,3 +0,0 @@
-fileFormatVersion: 2
-guid: 1006234332be4f329fc1830319b31aaa
-timeCreated: 1704502465

Packages/src/Editor/AssetModification/UIParticleComponentModifier_AbsoluteMode.cs

@@ -1,31 +0,0 @@
-using Coffee.UIExtensions;
-using Coffee.UIParticleInternal.AssetModification;
-using UnityEditor;
-
-#pragma warning disable CS0612 // Type or member is obsolete
-
-namespace Coffee.UIParticleInternal
-{
-    internal class UIParticleComponentModifier_AbsoluteMode : ComponentModifier<UIParticle>
-    {
-        protected override bool ModifyComponent(UIParticle uip, bool dryRun)
-        {
-            if (!uip.m_AbsoluteMode) return false;
-
-            uip.m_AbsoluteMode = false;
-            uip.positionMode = UIParticle.PositionMode.Absolute;
-
-            if (!dryRun)
-            {
-                EditorUtility.SetDirty(uip);
-            }
-
-            return true;
-        }
-
-        public override string Report()
-        {
-            return "  -> UIParticle.absoluteMode is obsolete. Use UIParticle.positionMode instead.\n";
-        }
-    }
-}

Packages/src/Editor/AssetModification/UIParticleComponentModifier_AbsoluteMode.cs.meta

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

Packages/src/Editor/AssetModification/UIParticleComponentModifier_AutoScaling.cs

@@ -1,36 +0,0 @@
-using Coffee.UIExtensions;
-using Coffee.UIParticleInternal.AssetModification;
-using UnityEditor;
-using UnityEngine;
-
-#pragma warning disable CS0612 // Type or member is obsolete
-
-namespace Coffee.UIParticleInternal
-{
-    internal class UIParticleComponentModifier_AutoScaling : ComponentModifier<UIParticle>
-    {
-        protected override bool ModifyComponent(UIParticle uip, bool dryRun)
-        {
-            if (!uip.m_AutoScaling) return false;
-
-            uip.m_AutoScaling = false;
-            uip.autoScalingMode = UIParticle.AutoScalingMode.Transform;
-            uip.transform.localScale = Vector3.one;
-
-            if (!dryRun)
-            {
-                EditorUtility.SetDirty(uip);
-                EditorUtility.SetDirty(uip.transform);
-            }
-
-            return true;
-        }
-
-        public override string Report()
-        {
-            return
-                "  -> UIParticle.ignoreCanvasScaler and UIParticle.autoScaling are obsolete." +
-                " Use UIParticle.autoScalingMode instead.\n";
-        }
-    }
-}

Packages/src/Editor/AssetModification/UIParticleComponentModifier_IsTrail.cs

@@ -1,31 +0,0 @@
-using Coffee.UIExtensions;
-using Coffee.UIParticleInternal.AssetModification;
-using UnityEditor;
-using UnityEngine;
-
-#pragma warning disable CS0612 // Type or member is obsolete
-
-namespace Coffee.UIParticleInternal
-{
-    internal class UIParticleComponentModifier_IsTrail : ComponentModifier<UIParticle>
-    {
-        protected override bool ModifyComponent(UIParticle uip, bool dryRun)
-        {
-            if (!uip.m_IsTrail) return false;
-
-            if (!dryRun)
-            {
-                var go = uip.gameObject;
-                Object.DestroyImmediate(uip);
-                EditorUtility.SetDirty(go);
-            }
-
-            return true;
-        }
-
-        public override string Report()
-        {
-            return "  -> UIParticle for trail is no longer needed. Removed.";
-        }
-    }
-}

Packages/src/Editor/AssetModification/UIParticleComponentModifier_IsTrail.cs.meta

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

Packages/src/Editor/AssetModification/UIParticleModifierRunner.cs

@@ -1,45 +0,0 @@
-using System;
-using System.Collections.Generic;
-using Coffee.UIParticleInternal.AssetModification;
-using UnityEditor;
-
-namespace Coffee.UIParticleInternal
-{
-    internal class UIParticleModifierRunner : Runner
-    {
-        public UIParticleModifierRunner()
-            : base("UIParticle v5", new List<(string, Func<string, Modifier>)>
-            {
-                (".unity", x => new SceneModifier
-                {
-                    path = x,
-                    componentModifiers = new IComponentModifier[]
-                    {
-                        new UIParticleRendererComponentModifier(),
-                        new UIParticleComponentModifier_AutoScaling(),
-                        new UIParticleComponentModifier_AbsoluteMode(),
-                        new UIParticleComponentModifier_IsTrail()
-                    }
-                }),
-                (".prefab", x => new PrefabModifier
-                {
-                    path = x,
-                    componentModifiers = new IComponentModifier[]
-                    {
-                        new UIParticleRendererComponentModifier(),
-                        new UIParticleComponentModifier_AutoScaling(),
-                        new UIParticleComponentModifier_AbsoluteMode(),
-                        new UIParticleComponentModifier_IsTrail()
-                    }
-                })
-            })
-        {
-        }
-
-        [MenuItem("UIParticleModifierRunner/Run")]
-        private static void Run()
-        {
-            new UIParticleModifierRunner().RunIfUserWantsTo();
-        }
-    }
-}

Packages/src/Editor/AssetModification/UIParticleModifierRunner.cs.meta

@@ -1,3 +0,0 @@
-fileFormatVersion: 2
-guid: edd678db452e49869caeca7e7d269e5d
-timeCreated: 1704502476

Packages/src/Editor/AssetModification/UIParticleRendererComponentModifier.cs

@@ -1,29 +0,0 @@
-using Coffee.UIExtensions;
-using Coffee.UIParticleInternal.AssetModification;
-using UnityEditor;
-using UnityEngine;
-
-namespace Coffee.UIParticleInternal
-{
-    internal class UIParticleRendererComponentModifier : ComponentModifier<UIParticleRenderer>
-    {
-        protected override bool ModifyComponent(UIParticleRenderer c, bool dryRun)
-        {
-            if (c.hideFlags.HasFlag(HideFlags.DontSave | HideFlags.NotEditable)) return false;
-
-            if (!dryRun)
-            {
-                var go = c.gameObject;
-                Object.DestroyImmediate(c);
-                EditorUtility.SetDirty(go);
-            }
-
-            return true;
-        }
-
-        public override string Report()
-        {
-            return "  -> UIParticleRenderer component is now auto-generated object. Remove them.\n";
-        }
-    }
-}

Packages/src/Editor/AssetModification/UIParticleRendererComponentModifier.cs.meta

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

Packages/src/Editor/Internal/AssetModification/ComponentModifier.cs

@@ -1,33 +0,0 @@
-using System.Collections.Generic;
-using UnityEditor;
-using UnityEngine;
-
-namespace Coffee.UIParticleInternal.AssetModification
-{
-    internal abstract class ComponentModifier<T> : IComponentModifier where T : Component
-    {
-        private static readonly List<T> s_Components = new List<T>();
-
-        public bool isModified { get; private set; }
-
-        public bool ModifyComponent(GameObject root, bool dryRun)
-        {
-            root.GetComponentsInChildren(true, s_Components);
-            foreach (var c in s_Components)
-            {
-                if (PrefabUtility.IsPartOfAnyPrefab(c.gameObject)) continue;
-
-                if (ModifyComponent(c, dryRun))
-                {
-                    isModified = true;
-                }
-            }
-
-            return isModified;
-        }
-
-        public abstract string Report();
-
-        protected abstract bool ModifyComponent(T component, bool dryRun);
-    }
-}

Packages/src/Editor/Internal/AssetModification/ComponentModifier.cs.meta

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

Packages/src/Editor/Internal/AssetModification/GameObjectModifier.cs

@@ -1,43 +0,0 @@
-using System.Linq;
-using System.Text;
-using UnityEngine;
-
-namespace Coffee.UIParticleInternal.AssetModification
-{
-    internal abstract class GameObjectModifier : Modifier
-    {
-        private static readonly StringBuilder s_ReportLog = new StringBuilder();
-        public IComponentModifier[] componentModifiers;
-
-        protected bool ModifyGameObject(GameObject root, bool dryRun)
-        {
-            foreach (var modifier in componentModifiers)
-            {
-                modifier.ModifyComponent(root, dryRun);
-            }
-
-            return componentModifiers.Any(x => x.isModified);
-        }
-
-        protected override string ModificationReport()
-        {
-            if (!hasUpgraded) return string.Empty;
-
-            s_ReportLog.Length = 0;
-            foreach (var componentModifier in componentModifiers)
-            {
-                if (componentModifier.isModified)
-                {
-                    s_ReportLog.Append(componentModifier.Report());
-                }
-            }
-
-            if (0 < s_ReportLog.Length)
-            {
-                s_ReportLog.Length--;
-            }
-
-            return s_ReportLog.ToString();
-        }
-    }
-}

Packages/src/Editor/Internal/AssetModification/GameObjectModifier.cs.meta

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

Packages/src/Editor/Internal/AssetModification/IComponentModifier.cs

@@ -1,11 +0,0 @@
-using UnityEngine;
-
-namespace Coffee.UIParticleInternal.AssetModification
-{
-    internal interface IComponentModifier
-    {
-        bool isModified { get; }
-        bool ModifyComponent(GameObject root, bool dryRun);
-        string Report();
-    }
-}

Packages/src/Editor/Internal/AssetModification/IComponentModifier.cs.meta

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

Packages/src/Editor/Internal/AssetModification/ITextModifier.cs

@@ -1,9 +0,0 @@
-using System.Text;
-
-namespace Coffee.UIParticleInternal.AssetModification
-{
-    internal interface ITextModifier
-    {
-        bool ModifyText(StringBuilder sb, string text);
-    }
-}

Packages/src/Editor/Internal/AssetModification/ITextModifier.cs.meta

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

Packages/src/Editor/Internal/AssetModification/Modifier.cs

@@ -1,41 +0,0 @@
-using System;
-
-namespace Coffee.UIParticleInternal.AssetModification
-{
-    internal abstract class Modifier
-    {
-        private string _error;
-        public string path;
-
-        protected abstract string id { get; }
-        protected bool hasUpgraded { private set; get; }
-
-        public void Modify(bool dryRun)
-        {
-            try
-            {
-                hasUpgraded = RunModify(dryRun);
-            }
-            catch (Exception e)
-            {
-                _error = e.Message;
-            }
-        }
-
-        public string GetModificationReport()
-        {
-            return !string.IsNullOrEmpty(_error)
-                ? $"<b><color=red>[{id} (Error)]</color> {path}</b> {_error}\n"
-                : hasUpgraded
-                    ? $"<b><color=green>[{id}]</color> {path}</b> {ModificationReport()}\n"
-                    : string.Empty;
-        }
-
-        protected abstract bool RunModify(bool dryRun);
-
-        protected virtual string ModificationReport()
-        {
-            return string.Empty;
-        }
-    }
-}

Packages/src/Editor/Internal/AssetModification/Modifier.cs.meta

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

Packages/src/Editor/Internal/AssetModification/PrefabModifier.cs

@@ -1,48 +0,0 @@
-using System;
-using UnityEditor;
-using UnityEngine;
-
-namespace Coffee.UIParticleInternal.AssetModification
-{
-    internal class PrefabModifier : GameObjectModifier
-    {
-        protected override string id => "Prefab";
-
-        protected override bool RunModify(bool dryRun)
-        {
-            using (var scope = new EditScope(path))
-            {
-                var changed = ModifyGameObject(scope.root, dryRun);
-
-                if (!dryRun && changed)
-                {
-                    scope.Save();
-                }
-
-                return changed;
-            }
-        }
-
-        private readonly struct EditScope : IDisposable
-        {
-            private readonly string _path;
-            public readonly GameObject root;
-
-            public EditScope(string path)
-            {
-                _path = path;
-                root = PrefabUtility.LoadPrefabContents(path);
-            }
-
-            public void Dispose()
-            {
-                PrefabUtility.UnloadPrefabContents(root);
-            }
-
-            public void Save()
-            {
-                PrefabUtility.SaveAsPrefabAsset(root, _path);
-            }
-        }
-    }
-}

Packages/src/Editor/Internal/AssetModification/PrefabModifier.cs.meta

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

Packages/src/Editor/Internal/AssetModification/Runner.cs

@@ -1,97 +0,0 @@
-using System;
-using System.Collections.Generic;
-using System.IO;
-using System.Linq;
-using System.Text;
-using UnityEditor;
-using UnityEditor.SceneManagement;
-using UnityEngine;
-
-namespace Coffee.UIParticleInternal.AssetModification
-{
-    internal class Runner
-    {
-        private readonly List<(string ext, Func<string, Modifier> create)> _factory;
-        private readonly string _name;
-
-        protected Runner(string name, List<(string ext, Func<string, Modifier> create)> factory)
-        {
-            _name = name;
-            _factory = factory;
-        }
-
-        private Modifier CreateFromPath(string assetPath)
-        {
-            var ext = Path.GetExtension(assetPath);
-            return _factory
-                .FirstOrDefault(x => x.ext == ext)
-                .create?.Invoke(assetPath);
-        }
-
-        private Modifier[] GetModifiers(string[] assetPaths)
-        {
-            return assetPaths
-                .Where(x => x.StartsWith("Assets/", StringComparison.Ordinal))
-                .Select(CreateFromPath)
-                .Where(x => x != null)
-                .OrderBy(x => Path.GetExtension(x.path))
-                .ToArray();
-        }
-
-        public void RunIfUserWantsTo()
-        {
-            var select = EditorUtility.DisplayDialogComplex($"Upgrade {_name}",
-                "Upgrade all assets in this project?\n\n" +
-                "'Go Ahead': Upgrades all assets in this project using the old APIs. You should make a backup before proceeding.\n\n" +
-                "'Dry Run': Outputs the upgrade summary to the console without changing.", "I Made a Backup. Go Ahead!",
-                "No Thanks", "Dry Run");
-            if (select == 1) return;
-
-            if (!EditorSceneManager.SaveCurrentModifiedScenesIfUserWantsTo()) return;
-
-            var assetPaths = AssetDatabase.GetAllAssetPaths();
-            var dryRun = select == 2;
-            Run(assetPaths, dryRun);
-        }
-
-        public void Run(string[] assetPaths, bool dryRun)
-        {
-            var modifiers = GetModifiers(assetPaths);
-            var canceled = false;
-
-            try
-            {
-                AssetDatabase.StartAssetEditing();
-                EditorSceneManager.NewScene(NewSceneSetup.EmptyScene, NewSceneMode.Single);
-
-                for (var i = 0; i < modifiers.Length; i++)
-                {
-                    var percentage = (float)i / modifiers.Length;
-                    var m = modifiers[i];
-                    if (EditorUtility.DisplayCancelableProgressBar("Upgrading...", m.path, percentage))
-                    {
-                        canceled = true;
-                        break;
-                    }
-
-                    m.Modify(dryRun);
-                }
-            }
-            catch (Exception e)
-            {
-                Debug.LogException(e);
-            }
-            finally
-            {
-                var sb = new StringBuilder();
-                sb.Append(dryRun ? "<b>[DryRun]</b> " : "");
-                sb.AppendLine($"<b>Modify '{_name}' is {(canceled ? "canceled" : "completed")}.</b>");
-                sb.AppendLine("==== Modifications ====");
-                Debug.Log(modifiers.Aggregate(sb, (x, m) => x.Append(m.GetModificationReport())));
-                EditorUtility.ClearProgressBar();
-                AssetDatabase.StopAssetEditing();
-                AssetDatabase.Refresh();
-            }
-        }
-    }
-}

Packages/src/Editor/Internal/AssetModification/Runner.cs.meta

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

Packages/src/Editor/Internal/AssetModification/SceneModifier.cs

@@ -1,53 +0,0 @@
-using System;
-using UnityEditor.SceneManagement;
-using UnityEngine.SceneManagement;
-
-namespace Coffee.UIParticleInternal.AssetModification
-{
-    internal class SceneModifier : GameObjectModifier
-    {
-        protected override string id => "Scene";
-
-        protected override bool RunModify(bool dryRun)
-        {
-            using (var scope = new EditScope(path))
-            {
-                var changed = false;
-                foreach (var root in scope.scene.GetRootGameObjects())
-                {
-                    if (ModifyGameObject(root, dryRun))
-                    {
-                        changed = true;
-                    }
-                }
-
-                if (!dryRun && changed)
-                {
-                    scope.Save();
-                }
-
-                return changed;
-            }
-        }
-
-        private readonly struct EditScope : IDisposable
-        {
-            public readonly Scene scene;
-
-            public EditScope(string path)
-            {
-                scene = EditorSceneManager.OpenScene(path, OpenSceneMode.Additive);
-            }
-
-            public void Dispose()
-            {
-                EditorSceneManager.CloseScene(scene, true);
-            }
-
-            public void Save()
-            {
-                EditorSceneManager.SaveScene(scene);
-            }
-        }
-    }
-}

Packages/src/Editor/Internal/AssetModification/SceneModifier.cs.meta

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

Packages/src/Editor/Internal/AssetModification/TextAssetModifier.cs

@@ -1,78 +0,0 @@
-using System;
-using System.Collections.Generic;
-using System.IO;
-using System.Text;
-
-namespace Coffee.UIParticleInternal.AssetModification
-{
-    internal class TextAssetModifier : Modifier
-    {
-        public ITextModifier[] textModifiers;
-        protected override string id => "Text";
-        protected virtual string savePath => path;
-
-        protected override bool RunModify(bool dryRun)
-        {
-            var changed = false;
-            using (var scope = new EditScope(path, savePath))
-            {
-                foreach (var line in scope.lines)
-                {
-                    if (ModifyLine(scope.sb, line))
-                    {
-                        changed = true;
-                    }
-                    else
-                    {
-                        scope.sb.AppendLine(line);
-                    }
-                }
-
-                if (!dryRun && changed)
-                {
-                    scope.Save();
-                }
-
-                return changed;
-            }
-        }
-
-        private bool ModifyLine(StringBuilder sb, string line)
-        {
-            foreach (var modifier in textModifiers)
-            {
-                if (modifier.ModifyText(sb, line))
-                {
-                    return true;
-                }
-            }
-
-            return false;
-        }
-
-        private readonly struct EditScope : IDisposable
-        {
-            private static readonly StringBuilder s_File = new StringBuilder();
-            private readonly string _path;
-            private readonly string _savePath;
-            public IEnumerable<string> lines => File.ReadLines(_path);
-            public StringBuilder sb => s_File;
-
-            public EditScope(string path, string savePath)
-            {
-                s_File.Length = 0;
-                _path = path;
-                _savePath = savePath;
-            }
-
-            public void Dispose()
-            {
-            }
-
-            public void Save()
-            {
-                File.WriteAllText(_savePath, sb.ToString());
-            }
-        }
-    }
-}

Packages/src/Editor/Internal/AssetModification/TextAssetModifier.cs.meta

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

Packages/src/Editor/Internal/AssetModification/TextReplaceModifier.cs

@@ -1,25 +0,0 @@
-using System.Text;
-using System.Text.RegularExpressions;
-
-namespace Coffee.UIParticleInternal.AssetModification
-{
-    internal class TextReplaceModifier : ITextModifier
-    {
-        private readonly Regex _pattern;
-        private readonly string _replace;
-
-        public TextReplaceModifier(string pattern, string replace)
-        {
-            _pattern = new Regex(pattern);
-            _replace = replace;
-        }
-
-        public bool ModifyText(StringBuilder sb, string text)
-        {
-            if (!_pattern.IsMatch(text)) return false;
-
-            sb.AppendLine(_pattern.Replace(text, _replace));
-            return true;
-        }
-    }
-}

Packages/src/Editor/Internal/AssetModification/TextReplaceModifier.cs.meta

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

Packages/src/Editor/UIParticleEditor.cs

@@ -2,19 +2,22 @@ using System.Collections.Generic;
 using System.Linq;
 using System.Text.RegularExpressions;
 using UnityEditor;
-using UnityEditor.UI;
 using UnityEditorInternal;
 using UnityEngine;
 using UnityEngine.UI;
+
 #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;
+
 #elif UNITY_2018_3_OR_NEWER
 using UnityEditor.Experimental.SceneManagement;
 #endif
@@ -23,7 +26,7 @@ namespace Coffee.UIExtensions
 {
     [CustomEditor(typeof(UIParticle))]
     [CanEditMultipleObjects]
-    internal class UIParticleEditor : GraphicEditor
+    internal class UIParticleEditor : Editor
     {
 #if UNITY_2021_2_OR_NEWER
 #if UNITY_2022_1_OR_NEWER
@@ -143,10 +146,8 @@ namespace Coffee.UIExtensions
         /// <summary>
         /// This function is called when the object becomes enabled and active.
         /// </summary>
-        protected override void OnEnable()
+        private void OnEnable()
         {
-            base.OnEnable();
-
             _maskable = serializedObject.FindProperty("m_Maskable");
             _scale3D = serializedObject.FindProperty("m_Scale3D");
             _animatableProperties = serializedObject.FindProperty("m_AnimatableProperties");
@@ -526,9 +527,7 @@ namespace Coffee.UIExtensions
         {
             if (!p || (ignoreCurrent && target == p)) return;
 
-            var cr = p.canvasRenderer;
             DestroyImmediate(p);
-            DestroyImmediate(cr);
 
 #if UNITY_2018_3_OR_NEWER
             var stage = PrefabStageUtility.GetCurrentPrefabStage();

Packages/src/README.md

@@ -1,4 +1,4 @@
-# Particle Effect For UGUI (UI Particle)
+# <img alt="UIParticleIcon" src="https://github.com/mob-sakai/ParticleEffectForUGUI/assets/12690315/d76e105e-a840-4f61-a1f6-8cf311c0812d" width="26"/> Particle Effect For UGUI (UI Particle)
 
 This package provides a component to render particle effects for uGUI in Unity 2018.2 or later.  
 The particle rendering is maskable and sortable, without the need for an extra Camera, RenderTexture, or Canvas.
@@ -117,6 +117,16 @@ Or, use [UpmGitExtension](https://github.com/mob-sakai/UpmGitExtension) to insta
 
 <br><br>
 
+## ⚙ Upgrading from 3.x/4.x to 5.x
+
+### Breaking Changes
+
+- The default value of `UIParticle.scale` has been changed from `10` to `1`.
+- `UIParticle` no longer inherits from `MaskableGraphic`.
+- 
+
+<br><br>
+
 ## 🚀 Usage
 
 ### UIParticle Component
@@ -176,9 +186,10 @@ section.
 ### Script usage
 
 ```cs
-// Instant ParticleSystem prefab with UIParticle on runtime.
+// Instantiate ParticleSystem prefab with UIParticle on runtime.
 var go = GameObject.Instantiate(prefab);
 var uiParticle = go.AddComponent<UIParticle>();
+uiParticle.scale = 100;
 
 // Control by ParticleSystem.
 particleSystem.Play();

Packages/src/Runtime/UIParticle.cs

@@ -6,7 +6,6 @@ using UnityEngine;
 using UnityEngine.EventSystems;
 using UnityEngine.Rendering;
 using UnityEngine.Serialization;
-using UnityEngine.UI;
 using Random = UnityEngine.Random;
 
 [assembly: InternalsVisibleTo("Coffee.UIParticle.Editor")]
@@ -19,7 +18,7 @@ namespace Coffee.UIExtensions
     [ExecuteAlways]
     [RequireComponent(typeof(RectTransform))]
     [RequireComponent(typeof(CanvasRenderer))]
-    public class UIParticle : MaskableGraphic, ISerializationCallbackReceiver
+    public class UIParticle : UIBehaviour, ISerializationCallbackReceiver
     {
         public enum AutoScalingMode
         {
@@ -45,20 +44,23 @@ namespace Coffee.UIExtensions
 
         [HideInInspector]
         [SerializeField]
+        [Obsolete]
         internal bool m_IsTrail;
 
         [HideInInspector]
         [FormerlySerializedAs("m_IgnoreParent")]
         [SerializeField]
+        [Obsolete]
         private bool m_IgnoreCanvasScaler;
 
         [HideInInspector]
         [SerializeField]
-        private bool m_AbsoluteMode;
+        [Obsolete]
+        internal bool m_AbsoluteMode;
 
         [Tooltip("Particle effect scale")]
         [SerializeField]
-        private Vector3 m_Scale3D = new Vector3(10, 10, 10);
+        private Vector3 m_Scale3D = new Vector3(1, 1, 1);
 
         [Tooltip("Animatable material properties.\n" +
                  "If you want to change the material properties of the ParticleSystem in Animation, enable it.")]
@@ -93,25 +95,54 @@ namespace Coffee.UIExtensions
 
         [SerializeField]
         [Tooltip("Prevent the root-Canvas scale from affecting the hierarchy-scaled ParticleSystem.")]
-        private bool m_AutoScaling = true;
+        [Obsolete]
+        internal bool m_AutoScaling;
 
         [SerializeField]
         [Tooltip("Transform: Transform.lossyScale (=world scale) will be set to (1, 1, 1)." +
                  "UIParticle: UIParticle.scale will be adjusted.")]
         private AutoScalingMode m_AutoScalingMode = AutoScalingMode.Transform;
 
+        [SerializeField]
+        private bool m_Maskable = true;
+
         private readonly List<UIParticleRenderer> _renderers = new List<UIParticleRenderer>();
+        private Canvas _canvas;
         private int _groupId;
-        private Camera _orthoCamera;
+        private Camera _orthographicCamera;
         private DrivenRectTransformTracker _tracker;
 
-        /// <summary>
-        /// Should this graphic be considered a target for ray-casting?
-        /// </summary>
-        public override bool raycastTarget
+        public RectTransform rectTransform => transform as RectTransform;
+
+        public Canvas canvas
         {
-            get => false;
-            set { }
+            get
+            {
+                if (_canvas) return _canvas;
+
+                var tr = transform;
+                while (tr && !_canvas)
+                {
+                    if (tr.TryGetComponent(out _canvas)) return _canvas;
+                    tr = tr.parent;
+                }
+
+                return null;
+            }
+        }
+
+        /// <summary>
+        /// Does this graphic allow masking.
+        /// </summary>
+        public bool maskable
+        {
+            get => m_Maskable;
+            set
+            {
+                if (value == m_Maskable) return;
+                m_Maskable = value;
+                UpdateRendererMaterial();
+            }
         }
 
         /// <summary>
@@ -266,8 +297,6 @@ namespace Coffee.UIExtensions
             }
         }
 
-        public override Material materialForRendering => null;
-
         /// <summary>
         /// Paused.
         /// </summary>
@@ -275,15 +304,15 @@ namespace Coffee.UIExtensions
 
         public Vector3 parentScale { get; private set; }
 
-        public Vector3 canvasScale { get; private set; }
+        private Vector3 canvasScale { get; set; }
 
         protected override void OnEnable()
         {
             ResetGroupId();
             UpdateTracker();
             UIParticleUpdater.Register(this);
-            RegisterDirtyMaterialCallback(UpdateRendererMaterial);
 
+            //
             if (0 < particles.Count)
             {
                 RefreshParticles(particles);
@@ -293,7 +322,7 @@ namespace Coffee.UIExtensions
                 RefreshParticles();
             }
 
-            base.OnEnable();
+            UpdateRendererMaterial();
         }
 
         /// <summary>
@@ -304,9 +333,15 @@ namespace Coffee.UIExtensions
             UpdateTracker();
             UIParticleUpdater.Unregister(this);
             _renderers.ForEach(r => r.Reset());
-            UnregisterDirtyMaterialCallback(UpdateRendererMaterial);
+            _canvas = null;
+        }
 
-            base.OnDisable();
+        /// <summary>
+        /// Called when the state of the parent Canvas is changed.
+        /// </summary>
+        protected override void OnCanvasHierarchyChanged()
+        {
+            _canvas = null;
         }
 
         /// <summary>
@@ -316,11 +351,20 @@ namespace Coffee.UIExtensions
         {
         }
 
+        /// <summary>
+        /// This function is called when a direct or indirect parent of the transform of the GameObject has changed.
+        /// </summary>
+        protected override void OnTransformParentChanged()
+        {
+            _canvas = null;
+        }
+
 #if UNITY_EDITOR
         protected override void OnValidate()
         {
             base.OnValidate();
             UpdateTracker();
+            UpdateRendererMaterial();
         }
 #endif
 
@@ -330,6 +374,7 @@ namespace Coffee.UIExtensions
 
         void ISerializationCallbackReceiver.OnAfterDeserialize()
         {
+#pragma warning disable CS0612 // Type or member is obsolete
             if (m_IgnoreCanvasScaler || m_AutoScaling)
             {
                 m_IgnoreCanvasScaler = false;
@@ -342,31 +387,47 @@ namespace Coffee.UIExtensions
                 m_AbsoluteMode = false;
                 m_PositionMode = PositionMode.Absolute;
             }
+#pragma warning restore CS0612 // Type or member is obsolete
         }
 
+        /// <summary>
+        /// Play the ParticleSystems.
+        /// </summary>
         public void Play()
         {
             particles.Exec(p => p.Simulate(0, false, true));
             isPaused = false;
         }
 
+        /// <summary>
+        /// Pause the ParticleSystems.
+        /// </summary>
         public void Pause()
         {
             particles.Exec(p => p.Pause());
             isPaused = true;
         }
 
+        /// <summary>
+        /// Unpause the ParticleSystems.
+        /// </summary>
         public void Resume()
         {
             isPaused = false;
         }
 
+        /// <summary>
+        /// Stop the ParticleSystems.
+        /// </summary>
         public void Stop()
         {
             particles.Exec(p => p.Stop());
             isPaused = true;
         }
 
+        /// <summary>
+        /// Start emission of the ParticleSystems.
+        /// </summary>
         public void StartEmission()
         {
             particles.Exec(p =>
@@ -376,6 +437,9 @@ namespace Coffee.UIExtensions
             });
         }
 
+        /// <summary>
+        /// Stop emission of the ParticleSystems.
+        /// </summary>
         public void StopEmission()
         {
             particles.Exec(p =>
@@ -385,24 +449,34 @@ namespace Coffee.UIExtensions
             });
         }
 
+        /// <summary>
+        /// Clear the particles of the ParticleSystems.
+        /// </summary>
         public void Clear()
         {
             particles.Exec(p => p.Clear());
             isPaused = true;
         }
 
+        /// <summary>
+        /// Refresh UIParticle using the ParticleSystem instance.
+        /// </summary>
         public void SetParticleSystemInstance(GameObject instance)
         {
             SetParticleSystemInstance(instance, true);
         }
 
+        /// <summary>
+        /// Refresh UIParticle using the ParticleSystem instance.
+        /// </summary>
         public void SetParticleSystemInstance(GameObject instance, bool destroyOldParticles)
         {
             if (!instance) return;
 
-            foreach (Transform child in transform)
+            var childCount = transform.childCount;
+            for (var i = 0; i < childCount; i++)
             {
-                var go = child.gameObject;
+                var go = transform.GetChild(i).gameObject;
                 go.SetActive(false);
                 if (destroyOldParticles)
                 {
@@ -417,6 +491,10 @@ namespace Coffee.UIExtensions
             RefreshParticles(instance);
         }
 
+        /// <summary>
+        /// Refresh UIParticle using the prefab.
+        /// The prefab is automatically instantiated.
+        /// </summary>
         public void SetParticleSystemPrefab(GameObject prefab)
         {
             if (!prefab) return;
@@ -424,16 +502,31 @@ namespace Coffee.UIExtensions
             SetParticleSystemInstance(Instantiate(prefab.gameObject), true);
         }
 
+        /// <summary>
+        /// Refresh UIParticle.
+        /// Collect ParticleSystems under the GameObject and refresh the UIParticle.
+        /// </summary>
         public void RefreshParticles()
         {
             RefreshParticles(gameObject);
         }
 
+        /// <summary>
+        /// Refresh UIParticle.
+        /// Collect ParticleSystems under the GameObject and refresh the UIParticle.
+        /// </summary>
         private void RefreshParticles(GameObject root)
         {
             if (!root) return;
             root.GetComponentsInChildren(true, particles);
-            particles.RemoveAll(x => x.GetComponentInParent<UIParticle>(true) != this);
+            for (var i = particles.Count - 1; 0 <= i; i--)
+            {
+                var ps = particles[i];
+                if (!ps || ps.GetComponentInParent<UIParticle>(true) != this)
+                {
+                    particles.RemoveAt(i);
+                }
+            }
 
             for (var i = 0; i < particles.Count; i++)
             {
@@ -448,31 +541,39 @@ namespace Coffee.UIExtensions
             RefreshParticles(particles);
         }
 
-        public void RefreshParticles(List<ParticleSystem> particles)
+        /// <summary>
+        /// Refresh UIParticle using a list of ParticleSystems.
+        /// </summary>
+        public void RefreshParticles(List<ParticleSystem> particleSystems)
         {
+            // Collect children UIParticleRenderer components.
             // #246: Nullptr exceptions when using nested UIParticle components in hierarchy
             _renderers.Clear();
-            foreach (Transform child in transform)
+            var childCount = transform.childCount;
+            for (var i = 0; i < childCount; i++)
             {
-                var uiParticleRenderer = child.GetComponent<UIParticleRenderer>();
-
-                if (uiParticleRenderer != null)
+                var child = transform.GetChild(i);
+                if (child.TryGetComponent(out UIParticleRenderer uiParticleRenderer))
                 {
                     _renderers.Add(uiParticleRenderer);
                 }
             }
 
+            // Reset the UIParticleRenderer components.
             for (var i = 0; i < _renderers.Count; i++)
             {
                 _renderers[i].Reset(i);
             }
 
+            // Set the ParticleSystem to the UIParticleRenderer. If the trail is enabled, set it additionally.
             var j = 0;
-            for (var i = 0; i < particles.Count; i++)
+            for (var i = 0; i < particleSystems.Count; i++)
             {
-                var ps = particles[i];
+                var ps = particleSystems[i];
                 if (!ps) continue;
                 GetRenderer(j++).Set(this, ps, false);
+
+                // If the trail is enabled, set it additionally.
                 if (ps.trails.enabled)
                 {
                     GetRenderer(j++).Set(this, ps, true);
@@ -500,11 +601,10 @@ namespace Coffee.UIExtensions
             for (var i = 0; i < _renderers.Count; i++)
             {
                 var r = _renderers[i];
-                if (!r)
-                {
-                    RefreshParticles(particles);
-                    break;
-                }
+                if (r) continue;
+
+                RefreshParticles(particles);
+                break;
             }
 
             var bakeCamera = GetBakeCamera();
@@ -512,6 +612,7 @@ namespace Coffee.UIExtensions
             {
                 var r = _renderers[i];
                 if (!r) continue;
+
                 r.UpdateMesh(bakeCamera);
             }
         }
@@ -523,17 +624,6 @@ namespace Coffee.UIExtensions
                 : Random.Range(m_GroupId, m_GroupMaxId + 1);
         }
 
-        protected override void UpdateMaterial()
-        {
-        }
-
-        /// <summary>
-        /// Call to update the geometry of the Graphic onto the CanvasRenderer.
-        /// </summary>
-        protected override void UpdateGeometry()
-        {
-        }
-
         private void UpdateRendererMaterial()
         {
             for (var i = 0; i < _renderers.Count; i++)
@@ -571,22 +661,23 @@ namespace Coffee.UIExtensions
                 return root.worldCamera ? root.worldCamera : Camera.main;
             }
 
-            // When render mode is ScreenSpaceOverlay, use ortho-camera.
-            if (!_orthoCamera)
+            // When render mode is ScreenSpaceOverlay, use orthographic-camera.
+            if (!_orthographicCamera)
             {
-                // Find existing ortho-camera.
-                foreach (Transform child in transform)
+                // Find existing orthographic-camera.
+                var childCount = transform.childCount;
+                for (var i = 0; i < childCount; i++)
                 {
-                    var cam = child.GetComponent<Camera>();
-                    if (cam && cam.name == "[generated] UIParticleOverlayCamera")
+                    if (transform.GetChild(i).TryGetComponent<Camera>(out var cam)
+                        && cam.name == "[generated] UIParticleOverlayCamera")
                     {
-                        _orthoCamera = cam;
+                        _orthographicCamera = cam;
                         break;
                     }
                 }
 
-                // Create ortho-camera.
-                if (!_orthoCamera)
+                // Create orthographic-camera.
+                if (!_orthographicCamera)
                 {
                     var go = new GameObject("[generated] UIParticleOverlayCamera")
                     {
@@ -594,25 +685,24 @@ namespace Coffee.UIExtensions
                     };
                     go.SetActive(false);
                     go.transform.SetParent(transform, false);
-                    _orthoCamera = go.AddComponent<Camera>();
-                    _orthoCamera.enabled = false;
+                    _orthographicCamera = go.AddComponent<Camera>();
+                    _orthographicCamera.enabled = false;
                 }
             }
 
             //
-            var size = ((RectTransform)root.transform).rect.size;
-            _orthoCamera.orthographicSize = Mathf.Max(size.x, size.y) * root.scaleFactor;
-            _orthoCamera.transform.SetPositionAndRotation(new Vector3(0, 0, -1000), Quaternion.identity);
-            _orthoCamera.orthographic = true;
-            _orthoCamera.farClipPlane = 2000f;
+            _orthographicCamera.orthographicSize = 10;
+            _orthographicCamera.transform.SetPositionAndRotation(new Vector3(0, 0, -1000), Quaternion.identity);
+            _orthographicCamera.orthographic = true;
+            _orthographicCamera.farClipPlane = 2000f;
 
-            return _orthoCamera;
+            return _orthographicCamera;
         }
 
         private void UpdateTracker()
         {
 #pragma warning disable CS0618 // Type or member is obsolete
-            if (!enabled || !autoScaling || autoScalingMode != AutoScalingMode.Transform)
+            if (!enabled || autoScalingMode != AutoScalingMode.Transform)
 #pragma warning restore CS0618 // Type or member is obsolete
             {
                 _tracker.Clear();

Packages/src/Runtime/UIParticleProjectSettings.cs

@@ -0,0 +1,28 @@
+#pragma warning disable CS0414
+using Coffee.UIParticleInternal;
+using UnityEditor;
+using UnityEngine;
+
+namespace Coffee.UIExtensions
+{
+    public class UIParticleProjectSettings : PreloadedProjectSettings<UIParticleProjectSettings>
+    {
+        [Header("Setting")]
+        [SerializeField]
+        internal bool m_EnableLinearToGamma = true;
+
+        public static bool enableLinearToGamma
+        {
+            get => instance.m_EnableLinearToGamma;
+            set => instance.m_EnableLinearToGamma = value;
+        }
+
+#if UNITY_EDITOR
+        [SettingsProvider]
+        private static SettingsProvider CreateSettingsProvider()
+        {
+            return new PreloadedProjectSettingsProvider("Project/UI/UI Particle");
+        }
+#endif
+    }
+}

Packages/src/Runtime/UIParticleProjectSettings.cs.meta

@@ -1,5 +1,5 @@
 fileFormatVersion: 2
-guid: 3d6d0ca7ae8c641aa98b66fd91c05264
+guid: f22a23b9d98e440478697f4adf30e61c
 MonoImporter:
   externalObjects: {}
   serializedVersion: 2

Packages/src/Runtime/UIParticleRenderer.cs

@@ -22,17 +22,16 @@ namespace Coffee.UIExtensions
     [AddComponentMenu("")]
     internal class UIParticleRenderer : MaskableGraphic
     {
-        private static readonly List<Component> s_Components = new List<Component>();
         private static readonly CombineInstance[] s_CombineInstances = { new CombineInstance() };
         private static readonly List<Material> s_Materials = new List<Material>(2);
         private static MaterialPropertyBlock s_Mpb;
-        private static readonly List<UIParticleRenderer> s_Renderers = new List<UIParticleRenderer>();
-        private static readonly List<Color32> s_Colors = new List<Color32>();
+        private static readonly List<UIParticleRenderer> s_Renderers = new List<UIParticleRenderer>(8);
         private static readonly Vector3[] s_Corners = new Vector3[4];
         private bool _delay;
         private int _index;
         private bool _isTrail;
         private Bounds _lastBounds;
+        private Material _materialForRendering;
         private Material _modifiedMaterial;
         private UIParticle _parent;
         private ParticleSystem _particleSystem;
@@ -40,7 +39,7 @@ namespace Coffee.UIExtensions
         private Vector3 _prevPsPos;
         private Vector3 _prevScale;
         private Vector2Int _prevScreenSize;
-        private bool _prewarm;
+        private bool _preWarm;
         private ParticleSystemRenderer _renderer;
 
         public override Texture mainTexture => _isTrail ? null : _particleSystem.GetTextureForSprite();
@@ -91,6 +90,19 @@ namespace Coffee.UIExtensions
             }
         }
 
+        public override Material materialForRendering
+        {
+            get
+            {
+                if (!_materialForRendering)
+                {
+                    _materialForRendering = base.materialForRendering;
+                }
+
+                return _materialForRendering;
+            }
+        }
+
         public void Reset(int index = -1)
         {
             if (_renderer)
@@ -110,8 +122,7 @@ namespace Coffee.UIExtensions
             if (this && isActiveAndEnabled)
             {
                 material = null;
-                workerMesh.Clear();
-                canvasRenderer.SetMesh(workerMesh);
+                canvasRenderer.Clear();
                 _lastBounds = new Bounds();
                 enabled = false;
             }
@@ -202,10 +213,11 @@ namespace Coffee.UIExtensions
             );
             if (!MaterialRepository.Valid(hash, _modifiedMaterial))
             {
-                MaterialRepository.Get(hash, ref _modifiedMaterial, () => new Material(modifiedMaterial)
+                MaterialRepository.Get(hash, ref _modifiedMaterial, x => new Material(x.mat)
                 {
-                    hideFlags = HideFlags.HideAndDontSave
-                });
+                    hideFlags = HideFlags.HideAndDontSave,
+                    mainTexture = x.texture ? x.texture : x.mat.mainTexture
+                }, (mat: modifiedMaterial, texture));
             }
 
             return _modifiedMaterial;
@@ -219,20 +231,20 @@ namespace Coffee.UIExtensions
             gameObject.layer = parent.gameObject.layer;
 
             _particleSystem = ps;
-            _prewarm = _particleSystem.main.prewarm;
+            _preWarm = _particleSystem.main.prewarm;
 
 #if UNITY_EDITOR
             if (Application.isPlaying)
 #endif
             {
-                if (_particleSystem.isPlaying || _prewarm)
+                if (_particleSystem.isPlaying || _preWarm)
                 {
                     _particleSystem.Clear();
                     _particleSystem.Pause();
                 }
             }
 
-            _renderer = ps.GetComponent<ParticleSystemRenderer>();
+            ps.TryGetComponent(out _renderer);
             _renderer.enabled = false;
 
             //_emitter = emitter;
@@ -404,7 +416,7 @@ namespace Coffee.UIExtensions
                 _lastBounds = bounds;
 
                 // Convert linear color to gamma color.
-                if (canvas.ShouldGammaToLinearInMesh())
+                if (UIParticleProjectSettings.enableLinearToGamma && canvas.ShouldGammaToLinearInMesh())
                 {
                     workerMesh.LinearToGamma();
                 }
@@ -424,66 +436,49 @@ namespace Coffee.UIExtensions
 
             Profiler.EndSample();
 
+            // Update animatable material properties.
+            Profiler.BeginSample("[UIParticleRenderer] Update Animatable Material Properties");
+            UpdateMaterialProperties();
+            Profiler.EndSample();
 
             // Get grouped renderers.
+            Profiler.BeginSample("[UIParticleRenderer] Set Mesh");
             s_Renderers.Clear();
             if (_parent.useMeshSharing)
             {
                 UIParticleUpdater.GetGroupedRenderers(_parent.groupId, _index, s_Renderers);
             }
 
-            // Set mesh to the CanvasRenderer.
-            Profiler.BeginSample("[UIParticleRenderer] Set Mesh");
             for (var i = 0; i < s_Renderers.Count; i++)
             {
                 if (s_Renderers[i] == this) continue;
+
                 s_Renderers[i].canvasRenderer.SetMesh(workerMesh);
                 s_Renderers[i]._lastBounds = _lastBounds;
+                s_Renderers[i].canvasRenderer.materialCount = 1;
+                s_Renderers[i].canvasRenderer.SetMaterial(materialForRendering, 0);
             }
 
-            if (!_parent.canRender)
+            if (_parent.canRender)
+            {
+                canvasRenderer.SetMesh(workerMesh);
+            }
+            else
             {
                 workerMesh.Clear();
             }
 
-            canvasRenderer.SetMesh(workerMesh);
-            Profiler.EndSample();
-
-            // Update animatable material properties.
-            Profiler.BeginSample("[UIParticleRenderer] Update Animatable Material Properties");
-
-#if UNITY_EDITOR
-            if (_modifiedMaterial != material)
-            {
-                _renderer.GetSharedMaterials(s_Materials);
-                material = s_Materials[_isTrail ? 1 : 0];
-                s_Materials.Clear();
-                SetMaterialDirty();
-            }
-#endif
-
-            UpdateMaterialProperties();
-            if (_parent.useMeshSharing)
-            {
-                if (!_currentMaterialForRendering)
-                {
-                    _currentMaterialForRendering = materialForRendering;
-                }
-
-                for (var i = 0; i < s_Renderers.Count; i++)
-                {
-                    if (s_Renderers[i] == this) continue;
-
-                    s_Renderers[i].canvasRenderer.materialCount = 1;
-                    s_Renderers[i].canvasRenderer.SetMaterial(_currentMaterialForRendering, 0);
-                }
-            }
-
             Profiler.EndSample();
 
             s_Renderers.Clear();
         }
 
+        public override void SetMaterialDirty()
+        {
+            _materialForRendering = null;
+            base.SetMaterialDirty();
+        }
+
         /// <summary>
         /// Call to update the geometry of the Graphic onto the CanvasRenderer.
         /// </summary>
@@ -550,10 +545,7 @@ namespace Coffee.UIExtensions
                     return Matrix4x4.Scale(scale);
                 case ParticleSystemSimulationSpace.Custom:
                     return Matrix4x4.Translate(_particleSystem.main.customSimulationSpace.position.GetScaled(scale))
-                           //* Matrix4x4.Translate(wpos)
-                           * Matrix4x4.Scale(scale)
-                        //* Matrix4x4.Translate(-wpos)
-                        ;
+                           * Matrix4x4.Scale(scale);
                 default:
                     throw new NotSupportedException();
             }
@@ -569,7 +561,8 @@ namespace Coffee.UIExtensions
             var screenSize = new Vector2Int(Screen.width, Screen.height);
             var isWorldSpace = _particleSystem.IsWorldSpace();
             var canvasScale = _parent.canvas ? _parent.canvas.scaleFactor : 1f;
-            var resolutionChanged = _prevScreenSize != screenSize || _prevCanvasScale != canvasScale;
+            var resolutionChanged = _prevScreenSize != screenSize
+                                    || !Mathf.Approximately(_prevCanvasScale, canvasScale);
             if (resolutionChanged && isWorldSpace)
             {
                 // Update particle array size and get particles.
@@ -577,7 +570,7 @@ namespace Coffee.UIExtensions
                 var particles = ParticleSystemExtensions.GetParticleArray(size);
                 _particleSystem.GetParticles(particles, size);
 
-                // Resolusion resolver:
+                // Resolution resolver:
                 // (psPos / scale) / (prevPsPos / prevScale) -> psPos * scale.inv * prevPsPos.inv * prevScale
                 var modifier = psPos.GetScaled(
                     scale.Inverse(),
@@ -611,11 +604,11 @@ namespace Coffee.UIExtensions
                     ? Time.unscaledDeltaTime
                     : Time.deltaTime;
 
-            // Prewarm:
-            if (0 < deltaTime && _prewarm)
+            // Pre-warm:
+            if (0 < deltaTime && _preWarm)
             {
                 deltaTime += main.duration;
-                _prewarm = false;
+                _preWarm = false;
             }
 
             // get world position.
@@ -687,12 +680,12 @@ namespace Coffee.UIExtensions
             if (s_Mpb.isEmpty) return;
 
             // #41: Copy the value from MaterialPropertyBlock to CanvasRenderer
-            if (!_modifiedMaterial) return;
+            if (!materialForRendering) return;
 
             for (var i = 0; i < _parent.m_AnimatableProperties.Length; i++)
             {
                 var ap = _parent.m_AnimatableProperties[i];
-                ap.UpdateMaterialProperties(_modifiedMaterial, s_Mpb);
+                ap.UpdateMaterialProperties(materialForRendering, s_Mpb);
             }
 
             s_Mpb.Clear();

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