Upstream/Paper
1
0
Fork 0
mirror of https://github.com/PaperMC/Paper.git synced 2024-11-22 02:25:28 +01:00
Code Issues 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 committed by GitHub
parent 2f50b87277
commit 540deb7ef7
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 37 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -10,10 +10,10 @@ This adds a new Builder API which is much friendlier to use.
diff --git a/src/main/java/com/destroystokyo/paper/ParticleBuilder.java b/src/main/java/com/destroystokyo/paper/ParticleBuilder.java diff --git a/src/main/java/com/destroystokyo/paper/ParticleBuilder.java b/src/main/java/com/destroystokyo/paper/ParticleBuilder.java
new file mode 100644 new file mode 100644
index 0000000000000000000000000000000000000000..52f639b838e8b49952c560f20bacbad0337f279c index 0000000000000000000000000000000000000000..970084a788ab5547d16a5e08d4e9d9c769aca67e
--- /dev/null --- /dev/null
+++ b/src/main/java/com/destroystokyo/paper/ParticleBuilder.java +++ b/src/main/java/com/destroystokyo/paper/ParticleBuilder.java
@@ -0,0 +1,583 @@ @@ -0,0 +1,609 @@
+package com.destroystokyo.paper; +package com.destroystokyo.paper;
+ +
+import com.google.common.base.Preconditions; +import com.google.common.base.Preconditions;
@ -455,19 +455,22 @@ index 0000000000000000000000000000000000000000..52f639b838e8b49952c560f20bacbad0
+ +
+ /** + /**
+ * 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..52f639b838e8b49952c560f20bacbad0
+ */ + */
+ @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..52f639b838e8b49952c560f20bacbad0
+ +
+ /** + /**
+ * 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..52f639b838e8b49952c560f20bacbad0
+ +
+ /** + /**
+ * 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));
+ } + }
+ +
+ /** + /**