|
|
|
@ -2,16 +2,14 @@ Particle Effect For UGUI (UI Particle)
|
|
|
|
===
|
|
|
|
===
|
|
|
|
|
|
|
|
|
|
|
|
This plugin provide a component to render particle effect for uGUI in Unity 2018.2 or later.
|
|
|
|
This plugin provide a component to render particle effect for uGUI in Unity 2018.2 or later.
|
|
|
|
The particle rendering is maskable and sortable, without Camera, RenderTexture or Canvas.
|
|
|
|
The particle rendering is maskable and sortable, without Camera, RenderTexture or Canvas.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
[](https://openupm.com/packages/com.coffee.ui-particle/)
|
|
|
|
[](https://openupm.com/packages/com.coffee.ui-particle/)
|
|
|
|
[](https://github.com/mob-sakai/ParticleEffectForUGUI/releases)
|
|
|
|
[](https://github.com/mob-sakai/ParticleEffectForUGUI/releases)
|
|
|
|
|
|
|
|
[)](https://github.com/mob-sakai/ParticleEffectForUGUI/releases)
|
|
|
|
[](https://github.com/mob-sakai/ParticleEffectForUGUI/releases) [](https://github.com/mob-sakai/ParticleEffectForUGUI/blob/master/LICENSE.txt)
|
|
|
|
[](https://github.com/mob-sakai/ParticleEffectForUGUI/releases) [](https://github.com/mob-sakai/ParticleEffectForUGUI/blob/master/LICENSE.txt)
|
|
|
|
[](http://makeapullrequest.com)
|
|
|
|
[](http://makeapullrequest.com)
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<< [Description](#Description) | [Demo](#demo) | [Installation](#installation) | [Usage](#usage) | [Development Note](#development-note) | [Change log](https://github.com/mob-sakai/ParticleEffectForUGUI/blob/upm/CHANGELOG.md) >>
|
|
|
|
<< [Description](#Description) | [Demo](#demo) | [Installation](#installation) | [Usage](#usage) | [Development Note](#development-note) | [Change log](https://github.com/mob-sakai/ParticleEffectForUGUI/blob/upm/CHANGELOG.md) >>
|
|
|
|
@ -58,6 +56,8 @@ Compares this "Baking mesh" approach with the conventional approach:
|
|
|
|
* Support CanvasGroup alpha
|
|
|
|
* Support CanvasGroup alpha
|
|
|
|
* No allocations
|
|
|
|
* No allocations
|
|
|
|
* Support overlay, camera space and world space
|
|
|
|
* Support overlay, camera space and world space
|
|
|
|
|
|
|
|
* Support Universal Render Pipeline (URP) and High Definition Render Pipeline (HDRP)
|
|
|
|
|
|
|
|
* Support disabling `Enter Play Mode Options > Reload Domain`
|
|
|
|
* Support changing material property with AnimationClip (AnimatableProperty)
|
|
|
|
* Support changing material property with AnimationClip (AnimatableProperty)
|
|
|
|
|
|
|
|
|
|
|
|
* [4.0.0+] Support 8+ materials
|
|
|
|
* [4.0.0+] Support 8+ materials
|
|
|
|
@ -92,39 +92,41 @@ Compares this "Baking mesh" approach with the conventional approach:
|
|
|
|
|
|
|
|
|
|
|
|
### Requirement
|
|
|
|
### Requirement
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Unity 2018.2 or later
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
### Using OpenUPM
|
|
|
|
### Install via OpenUPM
|
|
|
|
|
|
|
|
|
|
|
|
This package is available on [OpenUPM](https://openupm.com).
|
|
|
|
This package is available on [OpenUPM](https://openupm.com).
|
|
|
|
You can install it via [openupm-cli](https://github.com/openupm/openupm-cli).
|
|
|
|
It's recommended to install it via [openupm-cli](https://github.com/openupm/openupm-cli).
|
|
|
|
```
|
|
|
|
```
|
|
|
|
openupm add com.coffee.ui-particle
|
|
|
|
openupm add com.coffee.ui-particle
|
|
|
|
```
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
|
|
### Using Git
|
|
|
|
### Install via Package Manager Window (using Git URL)
|
|
|
|
|
|
|
|
|
|
|
|
Find the manifest.json file in the Packages folder of your project and add a line to `dependencies` field.
|
|
|
|
1. Select `Window/Package Manager` menu to open `Package Manager` window.
|
|
|
|
|
|
|
|
2. Click `+` and `Install package from git URL...`
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
3. Input `https://github.com/mob-sakai/ParticleEffectForUGUI.git` and click `Install`
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
* `"com.coffee.ui-particle": "https://github.com/mob-sakai/ParticleEffectForUGUI.git"`
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
To update the package, change suffix `#{version}` to the target version.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
* `"com.coffee.ui-particle": "https://github.com/mob-sakai/ParticleEffectForUGUI.git#4.0.0",`
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Or, use [UpmGitExtension](https://github.com/mob-sakai/UpmGitExtension) to install and update the package.
|
|
|
|
Or, use [UpmGitExtension](https://github.com/mob-sakai/UpmGitExtension) to install and update the package.
|
|
|
|
|
|
|
|
|
|
|
|
### For Unity 2018.2
|
|
|
|
### Install via manifest.json (using Git URL)
|
|
|
|
|
|
|
|
|
|
|
|
Unity 2018.2 supports embedded packages.
|
|
|
|
1. Open `Packages/manifest.json` in your project.
|
|
|
|
|
|
|
|
2. Add this line below `"dependencies": {`
|
|
|
|
|
|
|
|
* `"com.coffee.ui-particle": "https://github.com/mob-sakai/ParticleEffectForUGUI.git",`
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
3. To update the package, change suffix `#{version}`.
|
|
|
|
|
|
|
|
* `"com.coffee.ui-particle": "https://github.com/mob-sakai/ParticleEffectForUGUI.git#4.2.0",`
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
### Install as an embed package
|
|
|
|
|
|
|
|
|
|
|
|
1. Download a source code zip file from [Releases](https://github.com/mob-sakai/ParticleEffectForUGUI/releases) page
|
|
|
|
1. Download a source code zip file from [Releases](https://github.com/mob-sakai/ParticleEffectForUGUI/releases) page
|
|
|
|
2. Extract it
|
|
|
|
2. Extract it and place it under `Packages` directory in your project.
|
|
|
|
3. Import it under `Packages` directory in your Unity project
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<br><br><br><br>
|
|
|
|
<br><br><br><br>
|
|
|
|
@ -161,17 +163,17 @@ Unity 2018.2 supports embedded packages.
|
|
|
|
|
|
|
|
|
|
|
|
`UIParticle` controls the ParticleSystems that is attached to its own game objects and child game objects.
|
|
|
|
`UIParticle` controls the ParticleSystems that is attached to its own game objects and child game objects.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| Properties | Description |
|
|
|
|
| Properties | Description |
|
|
|
|
| -- | -- |
|
|
|
|
| -- | -- |
|
|
|
|
| Maskable | Does this graphic allow masking. |
|
|
|
|
| Maskable | Does this graphic allow masking. |
|
|
|
|
| Ignore Canvas Scale | Ignore the scale of the root canvas.<br>This prevents it from displaying small even in hierarchy scaling mode of `ParticleSystem`. |
|
|
|
|
|
|
|
|
| Scale | Scale the rendering.<br>When the `3D` toggle is enabled, 3D scale (x,y,z) is supported. |
|
|
|
|
| Scale | Scale the rendering.<br>When the `3D` toggle is enabled, 3D scale (x,y,z) is supported. |
|
|
|
|
| Animatable Properties | If you want update material properties (e.g. `_MainTex_ST`, `_Color`) in AnimationClip, use this to mark the changes. |
|
|
|
|
| Animatable Properties | If you want update material properties (e.g. `_MainTex_ST`, `_Color`) in AnimationClip, use this to mark the changes. |
|
|
|
|
| Mesh Sharing | Particle simulation results are shared within the same group.<br>A large number of the same effects can be displayed with a small load.<br>When the `Random` toggle is enabled, it will be grouped randomaly. |
|
|
|
|
| Mesh Sharing | Particle simulation results are shared within the same group.<br>A large number of the same effects can be displayed with a small load.<br>When the `Random` toggle is enabled, it will be grouped randomaly. |
|
|
|
|
| Absolute Mode | The particles will be emitted at the ParticleSystem position.<br>Move the UIParticle/ParticleSystem to move the particle. |
|
|
|
|
| Position Mode | **Absolute:** Emit from the world position of the `ParticleSystem`.<br>**Relative:** Emit from the scaled position of the `ParticleSystem`. |
|
|
|
|
| Rendering Order | The ParticleSystems to be rendered.<br>You can change the rendering order and the materials. |
|
|
|
|
| Auto Scaling | Transform.lossyScale (=world scale) will be set to `(1, 1, 1)` on update.<br>It prevents the root-Canvas scale from affecting the hierarchy-scaled `ParticleSystem`. |
|
|
|
|
|
|
|
|
| Rendering Order | The ParticleSystem list to be rendered.<br>You can change the order and the materials. |
|
|
|
|
|
|
|
|
|
|
|
|
NOTE: Press `Refresh` button to reconstruct rendering order based on children ParticleSystem's sorting order and z position.
|
|
|
|
NOTE: Press `Refresh` button to reconstruct rendering order based on children ParticleSystem's sorting order and z position.
|
|
|
|
|
|
|
|
|
|
|
|
@ -227,7 +229,7 @@ uiParticle.Stop();
|
|
|
|
|
|
|
|
|
|
|
|
`UIParticleAttractor` attracts particles generated by the specified ParticleSystem.
|
|
|
|
`UIParticleAttractor` attracts particles generated by the specified ParticleSystem.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| Properties | Description |
|
|
|
|
| Properties | Description |
|
|
|
|
@ -237,6 +239,7 @@ uiParticle.Stop();
|
|
|
|
| Delay Rate | Delay to start attracting.<br>It is a percentage of the particle's start lifetime. |
|
|
|
|
| Delay Rate | Delay to start attracting.<br>It is a percentage of the particle's start lifetime. |
|
|
|
|
| Max Speed | Maximum speed of attracting.<br> If this value is too small, attracting may not be completed by the end of the lifetime and `OnAttracted` may not be called. |
|
|
|
|
| Max Speed | Maximum speed of attracting.<br> If this value is too small, attracting may not be completed by the end of the lifetime and `OnAttracted` may not be called. |
|
|
|
|
| Movement | Attracting movement type. (Linear, Smooth, Sphere) |
|
|
|
|
| Movement | Attracting movement type. (Linear, Smooth, Sphere) |
|
|
|
|
|
|
|
|
| Update Mode | **Normal:** Update with scaled delta time.<br>**Unscaled Time:** Update with unscaled delta time. |
|
|
|
|
| OnAttracted | An event called when attracting is complete (per particle). |
|
|
|
|
| OnAttracted | An event called when attracting is complete (per particle). |
|
|
|
|
|
|
|
|
|
|
|
|
<br><br><br><br>
|
|
|
|
<br><br><br><br>
|
|
|
|
@ -245,14 +248,31 @@ uiParticle.Stop();
|
|
|
|
|
|
|
|
|
|
|
|
### Shader Limitation
|
|
|
|
### Shader Limitation
|
|
|
|
|
|
|
|
|
|
|
|
UIParticles are based on UIVertex.
|
|
|
|
The use of UI shaders is recommended.
|
|
|
|
Therefore, only xy components is available for each UV in the shader. (zw components will be ignored).
|
|
|
|
|
|
|
|
So unfortunately UIParticles will not work well with some shaders.
|
|
|
|
|
|
|
|
When using custom vertex streams, you can fill zw components with "unnecessary" data.
|
|
|
|
|
|
|
|
https://github.com/mob-sakai/ParticleEffectForUGUI/issues/191
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
- If you need a simple Additive shader, use the `UI/Additive` shader instead.
|
|
|
|
- If you need a simple Additive shader, use the `UI/Additive` shader instead.
|
|
|
|
- If you need a simple alpha-blend shader, use the `UI/Default` shader instead.
|
|
|
|
- If you need a simple alpha-blend shader, use the `UI/Default` shader instead.
|
|
|
|
|
|
|
|
- If your custom shader does not work properly with UIParticle, consider creating a custom UI shader.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
#### Built-in shaders are not supported
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
UIParticle does not support all built-in shaders except for `UI/Default`.
|
|
|
|
|
|
|
|
If their use is detected, an error is displayed in the inspector.
|
|
|
|
|
|
|
|
Use UI shaders instead.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
#### UV.zw components will be discarded
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
UIParticleRenderer renders the particles based on UIVertex.
|
|
|
|
|
|
|
|
Therefore, only xy components is available for each UV in the shader. (zw components will be discarded).
|
|
|
|
|
|
|
|
So unfortunately UIParticles will not work well with some shaders.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
#### Custom vertex streams
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
When using custom vertex streams, you can fill zw components with "unnecessary" data.
|
|
|
|
|
|
|
|
https://github.com/mob-sakai/ParticleEffectForUGUI/issues/191
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<br>
|
|
|
|
|
|
|
|
|
|
|
|
### Overheads
|
|
|
|
### Overheads
|
|
|
|
|
|
|
|
|
|
|
|
|
mob-sakai