twin/paper-mc
1
0
Fork 0
mirror of https://github.com/PaperMC/Paper.git synced 2025-08-11 02:02:04 -07:00
Code Issues Packages Projects Releases Wiki Activity

Fix Color Particle API (#10895)

Browse Source 
* fix: check datatype of particles rather than particle-type

* feature: add ARGB channels

It keeps the functionality of the original color(int).

* fix: order

* fixes

---------

Co-authored-by: Jake Potrebic <jake.m.potrebic@gmail.com>
This commit is contained in:
TreemanKing
2024-09-23 07:06:40 +10:00
parent 300db3cfd0
commit 8f59e0a8a4
1 changed files with 35 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

44
patches/api/Expand-World.spawnParticle-API-and-add-Builder.patch
View File

@@ -455,19 +455,22 @@ index 0000000000000000000000000000000000000000..00000000000000000000000000000000
+ +
+ /** + /**
+ * Sets the particle Color. + * Sets the particle Color.
+ * Only valid for {@link Particle#DUST}. + * Only valid for particles with a data type of {@link Color} or {@link Particle.DustOptions}.
+ * + *
+ * @param color the new particle color + * @param color the new particle color
+ * @return a reference to this object. + * @return a reference to this object.
+ */ + */
+ @NotNull + @NotNull
+ public ParticleBuilder color(@Nullable Color color) { + public ParticleBuilder color(@Nullable Color color) {
+ if (particle.getDataType() == Color.class) {
+ return data(color);
+ }
+ return color(color, 1); + return color(color, 1);
+ } + }
+ +
+ /** + /**
+ * Sets the particle Color and size. + * Sets the particle Color and size.
+ * Only valid for {@link Particle#DUST}. + * Only valid for particles with a data type of {@link Particle.DustOptions}.
+ * + *
+ * @param color the new particle color + * @param color the new particle color
+ * @param size the size of the particle + * @param size the size of the particle
@@ -475,8 +478,8 @@ index 0000000000000000000000000000000000000000..00000000000000000000000000000000
+ */ + */
+ @NotNull + @NotNull
+ public ParticleBuilder color(@Nullable Color color, float size) { + public ParticleBuilder color(@Nullable Color color, float size) {
+ if (particle != Particle.DUST && color != null) { + if (particle.getDataType() != Particle.DustOptions.class && color != null) {
+ throw new IllegalStateException("Color may only be set on particle DUST."); + throw new IllegalStateException("The combination of Color and size cannot be set on this particle type.");
+ } + }
+ +
+ // We don't officially support reusing these objects, but here we go + // We don't officially support reusing these objects, but here we go
@@ -493,7 +496,7 @@ index 0000000000000000000000000000000000000000..00000000000000000000000000000000
+ +
+ /** + /**
+ * Sets the particle Color. + * Sets the particle Color.
+ * Only valid for {@link Particle#DUST}. + * Only valid for particles with a data type of {@link Color} or {@link Particle.DustOptions}.
+ * + *
+ * @param r red color component + * @param r red color component
+ * @param g green color component + * @param g green color component
@@ -507,14 +510,37 @@ index 0000000000000000000000000000000000000000..00000000000000000000000000000000
+ +
+ /** + /**
+ * Sets the particle Color. + * Sets the particle Color.
+ * Only valid for {@link Particle#DUST}. + * Only valid for particles with a data type of {@link Color} or {@link Particle.DustOptions}.
+ * <p>
+ * This method detects if the provided color integer is in RGB or ARGB format.
+ * If the alpha channel is zero, it treats the color as RGB. Otherwise, it treats it as ARGB.
+ * + *
+ * @param rgb an integer representing the red, green, and blue color components + * @param color an integer representing the color components. If the highest byte (alpha channel) is zero,
+ * the color is treated as RGB. Otherwise, it is treated as ARGB.
+ * @return a reference to this object. + * @return a reference to this object.
+ */ + */
+ @NotNull + @NotNull
+ public ParticleBuilder color(final int rgb) { + public ParticleBuilder color(final int color) {
+ return color(Color.fromRGB(rgb)); + int alpha = (color >> 24) & 0xFF;
+ if (alpha == 0) {
+ return color(Color.fromRGB(color));
+ }
+ return color(Color.fromARGB(color));
+ }
+
+ /**
+ * Sets the particle Color.
+ * Only valid for particles with a data type of {@link Color} or {@link Particle.DustOptions}.
+ *
+ * @param a alpha color component
+ * @param r red color component
+ * @param g green color component
+ * @param b blue color component
+ * @return a reference to this object.
+ */
+ @NotNull
+ public ParticleBuilder color(final int a, final int r, final int g, final int b) {
+ return color(Color.fromARGB(a, r, g, b));
+ } + }
+ +
+ /** + /**