mob-sakai / mob-sakai/ParticleEffectForUGUI
:mag: FAQ: Why Are My UIParticles Not Displayed Correctly?
Open
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/AdditiveorUI/Default.
- Most cases can be solved by using
- Particles are not masked
UIParticleis maskable.- Use maskable/clipable shader (such as
UI/AdditiveorUI/Default) - Set
MaskorRectMask2Dcomponent properly.
- Particles are too small
- If particles are small enough, they will not appear on the screen.
- Increase the
Scalevalue. - If you don't want to change the apparent size depending on the resolution, try the
Auto Scalingoption.
- Particles are too many
- No more than 65535 vertices can be displayed (for mesh combination limitations).
- Please set
Emissionmodule andMax ParticlesofParticleSystemproperly.
- Particles are emitted off-screen.
- When
Position Mode = Relative, particles are emitted from the scaled position of theParticleSystem, not from
the screen point of theParticleSystem. - Place the
ParticleSystemin the proper position or tryPosition Mode = Absolute.
- When
- Attaching
UIParticleto the same object asParticleSystemTransform.localScalewill be overridden by theAuto Scalingoption.- It is recommended to place
ParticleSystemunderUIParticle.
- If
Transform.localScalecontains 0, rendering will be skipped. - If you are using
Shapemodule, please check whether the scale includes 0. - Displayed particles are in the correct position but too large/too small
- Adjust
ParticleSystem.renderer.Min/MaxParticleSize.
- Adjust
- If
Trails.RibbonCountis 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
UIParticleto the parent is the recommended setup rather than attaching it directly to theParticleSystem.- When using
ParticleSystem.emission.rateOverDistance, it is recommended to move the transform ofUIParticlerather than theParticleSystem.
- When using
- (v3.4.0, v5.0.0-preview.18) Try changing the
Default View Size For Bakingsetting underProjectSettings > UI > UI Particleto a value such as 100 or 1000.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- 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