mob-sakai / mob-sakai/ParticleEffectForUGUI

:mag: FAQ: Why Are My UIParticles Not Displayed Correctly?

Open
#270 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

question
Dominant language
C#
Stars
6k
Forks
762
PR merge metrics
No merged PRs in 30d

Description

In this issue, I will add FAQs about using UIParticle.
Please subscribe to this issue to stay updated. 👍


If ParticleSystem alone displays particles correctly but UIParticle does not, please check the following points:

  • Shader Limitation
    • Most cases can be solved by using UI/Additive or UI/Default.
  • Particles are not masked
    • UIParticle is maskable.
    • Use maskable/clipable shader (such as UI/Additive or UI/Default)
    • Set Mask or RectMask2D component properly.
  • Particles are too small
    • If particles are small enough, they will not appear on the screen.
    • Increase the Scale value.
    • If you don't want to change the apparent size depending on the resolution, try the Auto Scaling option.
  • Particles are too many
    • No more than 65535 vertices can be displayed (for mesh combination limitations).
    • Please set Emission module and Max Particles of ParticleSystem properly.
  • Particles are emitted off-screen.
    • When Position Mode = Relative, particles are emitted from the scaled position of the ParticleSystem, not from
      the screen point of the ParticleSystem.
    • Place the ParticleSystem in the proper position or try Position Mode = Absolute.
  • Attaching UIParticle to the same object as ParticleSystem
    • Transform.localScale will be overridden by the Auto Scaling option.
    • It is recommended to place ParticleSystem under UIParticle.
  • If Transform.localScale contains 0, rendering will be skipped.
  • If you are using Shape module, please check whether the scale includes 0.
  • Displayed particles are in the correct position but too large/too small
    • Adjust ParticleSystem.renderer.Min/MaxParticleSize.
  • If Trails.RibbonCount is greater than 1, the following error occurs frequently.
    • Failed setting triangles. Some indices are referencing out of bounds vertices. IndexCount: 660, VertexCount: 222
  • Adding a UIParticle to the parent is the recommended setup rather than attaching it directly to the ParticleSystem.
    • When using ParticleSystem.emission.rateOverDistance, it is recommended to move the transform of UIParticle rather than the ParticleSystem.
  • (v3.4.0, v5.0.0-preview.18) Try changing the Default View Size For Baking setting under ProjectSettings > UI > UI Particle to a value such as 100 or 1000.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

The issue provides the FAQ content but names no documentation file, test, or entry point. First locate the repository's existing FAQ or documentation location, then add these UIParticle troubleshooting points and verify that the FAQ is published in the project's established documentation format.

Written by the indexing model from the issue text.

Assessment

Tech stack
csharp, unity
Domain
documentation, game-dev
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.