Adds implementation of entity_effect particle which changed in 1.20.5

Author: JorelAli

commandapi-platforms/commandapi-bukkit/commandapi-bukkit-nms/commandapi-bukkit-1.20.5/src/main/java/dev/jorel/commandapi/nms/NMS_1_20_R4.java

@@ -75,7 +75,6 @@
 import org.bukkit.entity.Player;
 import org.bukkit.help.HelpTopic;
 import org.bukkit.inventory.Recipe;
-import org.bukkit.potion.PotionEffectType;
 
 import com.google.common.collect.ImmutableList;
 import com.google.common.io.Files;
@@ -154,6 +153,7 @@
 import net.minecraft.core.component.DataComponentMap;
 import net.minecraft.core.component.PatchedDataComponentMap;
 import net.minecraft.core.particles.BlockParticleOption;
+import net.minecraft.core.particles.ColorParticleOption;
 import net.minecraft.core.particles.DustColorTransitionOptions;
 import net.minecraft.core.particles.DustParticleOptions;
 import net.minecraft.core.particles.ItemParticleOption;
@@ -658,6 +658,7 @@ public final org.bukkit.loot.LootTable getLootTable(CommandContext<CommandSource
 		return CraftLootTable.minecraftToBukkit(ResourceLocationArgument.getId(cmdCtx, key));
 	}
 
+	@Differs(from = "1.20.4", by = "New particle option ColorParticleOption")
 	@Override
 	public final ParticleData<?> getParticle(CommandContext<CommandSourceStack> cmdCtx, String key) {
 		final ParticleOptions particleOptions = ParticleArgument.getParticle(cmdCtx, key);
@@ -684,12 +685,26 @@ public final ParticleData<?> getParticle(CommandContext<CommandSourceStack> cmdC
 		} else if (particleOptions instanceof SculkChargeParticleOptions options) {
 			// CraftBukkit implements sculk charge particles as a (boxed) Float object
 			return new ParticleData<Float>(particle, Float.valueOf(options.roll()));
+		} else if (particleOptions instanceof ColorParticleOption options) {
+			return getParticleDataAsColorParticleOption(particle, options);
 		} else {
 			CommandAPI.getLogger().warning("Invalid particle data type for " + particle.getDataType().toString());
 			return new ParticleData<Void>(particle, null);
 		}
 	}
 
+	@Differs(from = "1.20.4", by = "This now exists")
+	private ParticleData<Color> getParticleDataAsColorParticleOption(Particle particle,
+			ColorParticleOption options) {
+		final Color color = Color.fromARGB(
+			(int) (options.getAlpha() * 255.0F),
+			(int) (options.getRed() * 255.0F),
+			(int) (options.getGreen() * 255.0F),
+			(int) (options.getBlue() * 255.0F)
+		);
+		return new ParticleData<Color>(particle, color);
+	}
+
 	@Differs(from = "1.20.4", by = "Now uses options#getFromColor instead of options.getColor")
 	private ParticleData<DustTransition> getParticleDataAsDustColorTransitionOption(Particle particle,
 			DustColorTransitionOptions options) {

commandapi-platforms/commandapi-bukkit/commandapi-bukkit-test/commandapi-bukkit-test-impl-1.20.5/src/main/java/dev/jorel/commandapi/test/ArgumentNMS.java

@@ -783,11 +783,7 @@ public ParticleData<?> getParticle(CommandContext cmdCtx, String key) {
 
 			final ParticleOptions particleOptions = ParticleArgument.getParticle(cmdCtx, key);
 
-//			registry.getResourceKey(particleOptions.getType()).get().
-			// registry.asLookup().
-			
 			String nmsKey = registry.getResourceKey(particleOptions.getType()).get().location().getPath();
-			System.out.println("Trying to find " + nmsKey + " but got " + map.get(nmsKey));
 			result = new ParticleData(map.get(nmsKey), null); //baseNMS.getParticle(cmdCtx, key);
 		}
 

commandapi-platforms/commandapi-bukkit/commandapi-bukkit-test/commandapi-bukkit-test-impl-1.20.5/src/main/java/dev/jorel/commandapi/test/MockNMS.java

@@ -449,7 +449,7 @@ public String getNMSParticleNameFromBukkit(Particle particle) {
 		// return BuiltInRegistries.PARTICLE_TYPE.getKey(CraftParticle.bukkitToMinecraft(particle)).toString();
 		// return particle.getKey().toString();
 
-		return Map.ofEntries(
+		Map<org.bukkit.Particle, String> particleMap = Map.ofEntries(
 			Map.entry(Particle.valueOf("EXPLOSION_NORMAL"), "poof"), 
 			Map.entry(Particle.valueOf("EXPLOSION_LARGE"), "explosion"), 
 			Map.entry(Particle.valueOf("EXPLOSION_HUGE"), "explosion_emitter"), 
@@ -548,7 +548,13 @@ public String getNMSParticleNameFromBukkit(Particle particle) {
 			Map.entry(Particle.valueOf("CHERRY_LEAVES"), "cherry_leaves"), 
 			Map.entry(Particle.valueOf("EGG_CRACK"), "egg_crack"), 
 			Map.entry(Particle.valueOf("BLOCK_MARKER"), "dust_plume")
-		).get(particle);
+		);
+
+		final String particleName = particleMap.get(particle);
+		if (particleName == null) {
+			System.err.println("Couldn't find particle name for " + particle);
+		}
+		return particleName;
 	}
 
 	@Override

commandapi-platforms/commandapi-bukkit/commandapi-bukkit-test/commandapi-bukkit-test-tests/src/test/java/dev/jorel/commandapi/test/arguments/ArgumentParticleTests.java

@@ -2,11 +2,13 @@
 
 import static org.junit.jupiter.api.Assertions.assertEquals;
 import static org.junit.jupiter.api.Assertions.assertTrue;
+import static org.junit.jupiter.api.Assumptions.assumeFalse;
 import static org.junit.jupiter.api.Assumptions.assumeTrue;
 
 import java.util.Set;
 import java.util.concurrent.ThreadLocalRandom;
 
+import org.bukkit.Bukkit;
 import org.bukkit.Color;
 import org.bukkit.Material;
 import org.bukkit.Particle;
@@ -43,6 +45,21 @@ public void setUp() {
 
 		// Disabled for 1.20.3+ due to "reasons"
 		// assumeTrue(version.lessThan(MCVersion.V1_20_3));
+		
+		/**
+		 * From https://misode.github.io/versions/?id=1.20.5-pre1&tab=changelog&tags=command
+		 * 
+		 * Changed the /particle command syntax for particles with extra options:
+
+block redstone_lamp[lit=true] → block{block_state:{Name:"redstone_lamp",Properties:{lit:"true"}}} (also for block_marker, falling_dust, and dust_pillar)
+dust 0.1 0.2 0.3 0.4 → dust{color:[0.1,0.2,0.3],scale:0.4}
+dust_color_transition 0.1 0.2 0.3 0.4 0.5 0.6 0.7 → dust_color_transition{from_color:[0.1,0.2,0.3],scale:0.4,to_color:[0.5,0.6,0.7]}
+entity_effect → entity_effect{color:[0.1,0.2,0.3,0.4]}
+item diamond → item{item:"diamond"}
+sculk_charge 0.1 → sculk_charge{roll:0.1}
+shriek 1 → shriek{delay:1}
+vibration 0.1 0.2 0.3 4 → vibration{destination:{type:"block",pos:[0.1,0.2,0.3]},arrival_in_ticks:4}
+		 */
 	}
 
 	@AfterEach
@@ -78,10 +95,17 @@ void executionTestWithParticleArgumentVoid() {
 
 		for (Particle particle : Particle.values()) {
 			if (particle.getDataType().equals(Void.class) && !dodgyParticles.contains(particle)) {
-				
-				// TODO: If 1.20.5+, we we can use particle.getKey() directly
-				
-				server.dispatchCommand(player, "test " + MockPlatform.getInstance().getNMSParticleNameFromBukkit(particle));
+				if (version.greaterThanOrEqualTo(MCVersion.V1_20_5) && particle.name().equals("SPELL_MOB")) {
+					// SPELL_MOB (entity_effect) has an additional parameter in 1.20.5 onwards
+					continue;
+				} else {
+					String particleName = MockPlatform.getInstance().getNMSParticleNameFromBukkit(particle);
+					if (particleName != null) {
+						server.dispatchCommand(player, "test " + particleName);
+					} else {
+						continue;
+					}
+				}
 				assertEquals(particle, results.get().particle());
 			}
 		}
@@ -180,10 +204,11 @@ void executionTestWithParticleArgumentBlock() {
 
 		PlayerMock player = server.addPlayer();
 
-		// block block_type[meta]
 		if (version.greaterThanOrEqualTo(MCVersion.V1_20_5)) {
-			server.dispatchCommand(player, "test block minecraft:grass_block{snowy:true}");
+			// block{block_state{state}}
+			server.dispatchCommand(player, "test block{block_state:{Name:\"minecraft:grass_block\",Properties:{snowy:\"true\"}}}");
 		} else {
+			// block block_type[meta]
 			server.dispatchCommand(player, "test block minecraft:grass_block[snowy=true]");
 		}
 
@@ -216,8 +241,13 @@ void executionTestWithParticleArgumentItem() {
 
 		PlayerMock player = server.addPlayer();
 
-		// item item_id
-		server.dispatchCommand(player, "test item apple");
+		if (version.greaterThanOrEqualTo(MCVersion.V1_20_5)) {
+			// item{item:"item_id"}
+			server.dispatchCommand(player, "test item{item:\"apple\"}");
+		} else {
+			// item item_id
+			server.dispatchCommand(player, "test item apple");
+		}
 		@SuppressWarnings("unchecked")
 		ParticleData<ItemStack> result = (ParticleData<ItemStack>) results.get();
 
@@ -232,5 +262,81 @@ void executionTestWithParticleArgumentItem() {
 
 		assertNoMoreResults(results);
 	}
+	
+	@Test
+	void executionTestWithParticleArgumentEntityEffect() {
+		// Only effective from 1.20.5+
+		assumeTrue(version.greaterThanOrEqualTo(MCVersion.V1_20_5));
+
+		Mut<ParticleData<?>> results = Mut.of();
+
+		new CommandAPICommand("test")
+			.withArguments(new ParticleArgument("particle"))
+			.executesPlayer((player, args) -> {
+				results.set(args.getUnchecked("particle"));
+			})
+			.register();
+
+		PlayerMock player = server.addPlayer();
+
+		// entity_effect{color:[r,g,b,a]}
+		// (red entity effect, fully visible)
+		server.dispatchCommand(player, "test entity_effect{color:[1.0,0.0,0.0,1.0]}");
+		
+		@SuppressWarnings("unchecked")
+		ParticleData<Color> result = (ParticleData<Color>) results.get();
+
+		assumeFalse(Bukkit.getBukkitVersion().equals("1.20.1-R0.1-SNAPSHOT"));
+
+		// Check the particle type is correct
+		assertEquals(Particle.valueOf("ENTITY_EFFECT"), result.particle());
+		
+		// TODO: Can't handle particle data yet in 1.20.5
+		assumeTrue(version.lessThan(MCVersion.V1_20_5));
+
+		// Check the particle properties
+		assertEquals(255, result.data().getRed());
+		assertEquals(0, result.data().getGreen());
+		assertEquals(0, result.data().getBlue());
+		assertEquals(255, result.data().getAlpha());
+
+		assertNoMoreResults(results);
+	}
+
+//	@Test
+//	void executionTestWithParticleArgumentVibration() {
+//		Mut<ParticleData<?>> results = Mut.of();
+//
+//		new CommandAPICommand("test")
+//			.withArguments(new ParticleArgument("particle"))
+//			.executesPlayer((player, args) -> {
+//				results.set((ParticleData<?>) args.get("particle"));
+//			})
+//			.register();
+//
+//		PlayerMock player = server.addPlayer();
+//
+//		// block block_type[meta]
+//		if (version.greaterThanOrEqualTo(MCVersion.V1_20_5)) {
+//			server.dispatchCommand(player, "test block{block_state:{Name:\"minecraft:grass_block\",Properties:{snowy:\"true\"}}}");
+//		} else {
+//			server.dispatchCommand(player, "test block minecraft:grass_block[snowy=true]");
+//		}
+//		
+//		@SuppressWarnings("unchecked")
+//		ParticleData<BlockData> result = (ParticleData<BlockData>) results.get();
+//
+//		// Check the particle type is correct
+//		assertEquals(Particle.BLOCK_CRACK, result.particle());
+//		
+//		// TODO: Can't handle particle data yet in 1.20.5
+//		assumeTrue(version.lessThan(MCVersion.V1_20_5));
+//
+//		// Check the particle properties
+//		assertEquals(Material.GRASS_BLOCK, result.data().getMaterial());
+//		assertTrue(((Snowable) result.data()).isSnowy());
+//
+//		assertNoMoreResults(results);
+//	}
 
 }