DarthSharkie / Apel-Mod

Apel is a library that brings particle animations to the table with flexible behaviour and a clean developer interface. It promises also lots of predefined shapes & paths to help the developer on their particle scene
Other
0 stars 0 forks source link

`ParticleCombiner`'s able to set a `null` particle effect on all children #35

Open DarthSharkie opened 5 months ago

DarthSharkie commented 5 months ago

This shouldn't be allowed, as ParticleObject specifies a @NonNull on particleEffect in some subclasses. This should be standardized across the subclasses and clearly documented.

DarthSharkie commented 5 months ago

This was clearly intended, even if it feels awkward. Needs discussion before fixing in any particular way, or leaving as-is.

DarthSharkie commented 4 months ago

Documentation is clear that this is a bad idea, at least:

The {@code particleEffect} may be null, but note that it will cause problems when rendering leaf-level objects
as the particle effect must be encoded to traverse the server to client network channel.  Setting a particle
effect on a ParticleCombiner does not have an effect on rendering.