Visual effects rework (#3939)

Author: TPGamesNL

src/main/java/ch/njol/skript/classes/data/SkriptClasses.java

@@ -18,15 +18,6 @@
  */
 package ch.njol.skript.classes.data;
 
-import java.io.StreamCorruptedException;
-import java.util.Locale;
-import java.util.regex.Pattern;
-
-import org.bukkit.Material;
-import org.bukkit.enchantments.Enchantment;
-import org.bukkit.inventory.ItemStack;
-import org.eclipse.jdt.annotation.Nullable;
-
 import ch.njol.skript.Skript;
 import ch.njol.skript.aliases.Aliases;
 import ch.njol.skript.aliases.ItemData;
@@ -59,11 +50,19 @@
 import ch.njol.skript.util.Timeperiod;
 import ch.njol.skript.util.Timespan;
 import ch.njol.skript.util.Utils;
-import ch.njol.skript.util.VisualEffect;
-import ch.njol.skript.util.VisualEffectDummy;
 import ch.njol.skript.util.WeatherType;
 import ch.njol.skript.util.slot.Slot;
+import ch.njol.skript.util.visual.VisualEffect;
+import ch.njol.skript.util.visual.VisualEffects;
 import ch.njol.yggdrasil.Fields;
+import org.bukkit.Material;
+import org.bukkit.enchantments.Enchantment;
+import org.bukkit.inventory.ItemStack;
+import org.eclipse.jdt.annotation.Nullable;
+
+import java.io.StreamCorruptedException;
+import java.util.Locale;
+import java.util.regex.Pattern;
 
 /**
  * @author Peter Güttinger
@@ -697,9 +696,9 @@ public String getVariableNamePattern() {
 					@Override
 					@Nullable
 					public Color parse(String input, ParseContext context) {
-						if (ColorRGB.isRGBColor(input)) {
-							return ColorRGB.fromString(input);
-						}
+						Color rgbColor = ColorRGB.fromString(input);
+						if (rgbColor != null)
+							return rgbColor;
 						return SkriptColor.fromName(input);
 					}
 
@@ -851,41 +850,38 @@ public Experience deserialize(final String s) {
 						}
 					}
 				}));
-		if (Skript.classExists("org.bukkit.Particle")) {
-			Classes.registerClass(new ClassInfo<>(VisualEffect.class, "visualeffect")
-					.name("Visual Effect")
-					.description("A visible effect, e.g. particles.")
-					.examples("show wolf hearts on the clicked wolf",
-							"play mob spawner flames at the targeted block to the player")
-					.usage(VisualEffect.getAllNames())
-					.since("2.1")
-					.user("(visual|particle) effects?")
-					.parser(new Parser<VisualEffect>() {
-						@Override
-						@Nullable
-						public VisualEffect parse(final String s, final ParseContext context) {
-							return VisualEffect.parse(s);
-						}
 
-						@Override
-						public String toString(final VisualEffect e, final int flags) {
-							return e.toString(flags);
-						}
+		Classes.registerClass(new ClassInfo<>(VisualEffect.class, "visualeffect")
+				.name("Visual Effect")
+				.description("A visible effect, e.g. particles.")
+				.examples("show wolf hearts on the clicked wolf",
+						"play mob spawner flames at the targeted block to the player")
+				.usage(VisualEffects.getAllNames())
+				.since("2.1")
+				.user("(visual|particle) effects?")
+				.parser(new Parser<VisualEffect>() {
+					@Override
+					@Nullable
+					public VisualEffect parse(String s, ParseContext context) {
+						return VisualEffects.parse(s);
+					}
 
-						@Override
-						public String toVariableNameString(final VisualEffect e) {
-							return e.toString();
-						}
+					@Override
+					public String toString(VisualEffect e, int flags) {
+						return e.toString(flags);
+					}
 
-						@Override
-						public String getVariableNamePattern() {
-							return ".*";
-						}
-					})
-					.serializer(new YggdrasilSerializer<VisualEffect>()));
-		} else {
-			Classes.registerClass(new ClassInfo<>(VisualEffectDummy.class, "visualeffect"));
-		}
+					@Override
+					public String toVariableNameString(VisualEffect e) {
+						return e.toString();
+					}
+
+					@Override
+					public String getVariableNamePattern() {
+						return ".*";
+					}
+				})
+				.serializer(new YggdrasilSerializer<>()));
 
 		Classes.registerClass(new ClassInfo<>(GameruleValue.class, "gamerulevalue")
 				.user("gamerule values?")

src/main/java/ch/njol/skript/effects/EffVisualEffect.java

@@ -34,30 +34,30 @@
 import ch.njol.skript.lang.Literal;
 import ch.njol.skript.lang.SkriptParser.ParseResult;
 import ch.njol.skript.util.Direction;
-import ch.njol.skript.util.VisualEffect;
+import ch.njol.skript.util.visual.VisualEffect;
 import ch.njol.util.Kleenean;
 
-/**
- * @author Peter Güttinger
- */
 @Name("Play Effect")
 @Description({"Plays a <a href='classes.html#visualeffect'>visual effect</a> at a given location or on a given entity.",
 		"Please note that some effects can only be played on entities, e.g. wolf hearts or the hurt effect, and that these are always visible to all players."})
 @Examples({"play wolf hearts on the clicked wolf",
 		"show mob spawner flames at the targeted block to the player"})
 @Since("2.1")
 public class EffVisualEffect extends Effect {
+
 	static {
-		Skript.registerEffect(EffVisualEffect.class, "(play|show) %visualeffects% (on|%directions%) %entities/locations% [(to %-players%|in (radius|range) of %number%)]",
-				"(play|show) %number% %visualeffects% (on|%directions%) %locations% [(to %-players%|in (radius|range) of %number%)]");
+		Skript.registerEffect(EffVisualEffect.class,
+			"(play|show) %visualeffects% (on|%directions%) %entities/locations% [(to %-players%|in (radius|range) of %number%)]",
+			"(play|show) %number% %visualeffects% (on|%directions%) %locations% [(to %-players%|in (radius|range) of %number%)]");
 	}
-	
-	@SuppressWarnings("null")
+
+	@SuppressWarnings("NotNullFieldNotInitialized")
 	private Expression<VisualEffect> effects;
-	@SuppressWarnings("null")
+	@SuppressWarnings("NotNullFieldNotInitialized")
 	private Expression<Direction> direction;
-	@SuppressWarnings("null")
+	@SuppressWarnings("NotNullFieldNotInitialized")
 	private Expression<?> where;
+
 	@Nullable
 	private Expression<Player> players;
 	@Nullable
@@ -67,7 +67,7 @@ public class EffVisualEffect extends Effect {
 
 	@SuppressWarnings({"unchecked", "null"})
 	@Override
-	public boolean init(final Expression<?>[] exprs, final int matchedPattern, final Kleenean isDelayed, final ParseResult parseResult) {
+	public boolean init(Expression<?>[] exprs, int matchedPattern, Kleenean isDelayed, ParseResult parseResult) {
 		int base = 0;
 		if (matchedPattern == 1) {
 			count = (Expression<Number>) exprs[0];
@@ -77,50 +77,57 @@ public boolean init(final Expression<?>[] exprs, final int matchedPattern, final
 		effects = (Expression<VisualEffect>) exprs[base];
 		direction = (Expression<Direction>) exprs[base + 1];
 		where = exprs[base + 2];
-		if (exprs[base + 3] != null) {
-			if (exprs[3].getReturnType() == Player.class)
-				players = (Expression<Player>) exprs[base + 3];
-			else
-				radius = (Expression<Number>) exprs[base + 3];
-		}
+		players = (Expression<Player>) exprs[base + 3];
+		radius = (Expression<Number>) exprs[base + 4];
+
 		if (effects instanceof Literal) {
-			final VisualEffect[] effs = effects.getAll(null);
-			boolean hasLocationEffect = false, hasEntityEffect = false;
-			for (final VisualEffect e : effs) {
-				if (e.isEntityEffect())
+			//noinspection ConstantConditions
+			VisualEffect[] effs = effects.getArray(null);
+
+			boolean hasLocationEffect = false;
+			boolean hasEntityEffect = false;
+			for (VisualEffect e : effs) {
+				if (e.getType().isEntityEffect())
 					hasEntityEffect = true;
 				else
 					hasLocationEffect = true;
 			}
+
 			if (!hasLocationEffect && players != null)
 				Skript.warning("Entity effects are visible to all players");
 			if (!hasLocationEffect && !direction.isDefault())
 				Skript.warning("Entity effects are always played on an entity");
-			if (hasEntityEffect && !Entity.class.isAssignableFrom(where.getReturnType()))
-				Skript.warning("Entity effects can only be played on entities");
+			if (hasEntityEffect && !Entity.class.isAssignableFrom(where.getReturnType())) {
+				Skript.error("Entity effects can only be played on entities");
+				return false;
+			}
 		}
+
 		return true;
 	}
 
 	@Override
-	protected void execute(final Event e) {
-		final VisualEffect[] effs = effects.getArray(e);
-		final Direction[] dirs = direction.getArray(e);
-		final Object[] os = where.getArray(e);
-		final Player[] ps = players != null ? players.getArray(e) : null;
-		final Number rad = radius != null ? radius.getSingle(e) : 32; // 32=default particle radius
-		final Number cnt = count != null ? count.getSingle(e) : 0;
-		assert rad != null;
-		assert cnt != null;
-		for (final Direction d : dirs) {
-			for (final Object o : os) {
+	protected void execute(Event e) {
+		VisualEffect[] effects = this.effects.getArray(e);
+		Direction[] directions = direction.getArray(e);
+		Object[] os = where.getArray(e);
+		Player[] ps = players != null ? players.getArray(e) : null;
+		Number rad = radius != null ? radius.getSingle(e) : 32; // 32=default particle radius
+		Number cnt = count != null ? count.getSingle(e) : 0;
+
+		// noinspection ConstantConditions
+		if (effects == null || directions == null || os == null || rad == null || cnt == null)
+			return;
+
+		for (Direction d : directions) {
+			for (Object o : os) {
 				if (o instanceof Entity) {
-					for (final VisualEffect eff : effs) {
+					for (VisualEffect eff : effects) {
 						eff.play(ps, d.getRelative((Entity) o), (Entity) o, cnt.intValue(), rad.intValue());
 					}
 				} else if (o instanceof Location) {
-					for (final VisualEffect eff : effs) {
-						if (eff.isEntityEffect())
+					for (VisualEffect eff : effects) {
+						if (eff.getType().isEntityEffect())
 							continue;
 						eff.play(ps, d.getRelative((Location) o), null, cnt.intValue(), rad.intValue());
 					}
@@ -132,8 +139,9 @@ protected void execute(final Event e) {
 	}
 
 	@Override
-	public String toString(final @Nullable Event e, final boolean debug) {
-		return "play " + effects.toString(e, debug) + " " + direction.toString(e, debug) + " " + where.toString(e, debug) + (players != null ? " to " + players.toString(e, debug) : "");
+	public String toString(@Nullable Event e, boolean debug) {
+		return "play " + effects.toString(e, debug) + " " + direction.toString(e, debug) + " "
+			+ where.toString(e, debug) + (players != null ? " to " + players.toString(e, debug) : "");
 	}
 
 }

src/main/java/ch/njol/skript/util/ColorRGB.java

@@ -18,19 +18,22 @@
  */
 package ch.njol.skript.util;
 
-import java.io.NotSerializableException;
-import java.io.StreamCorruptedException;
-
+import ch.njol.skript.variables.Variables;
+import ch.njol.util.Math2;
+import ch.njol.yggdrasil.Fields;
 import org.apache.commons.lang.math.NumberUtils;
 import org.bukkit.DyeColor;
 import org.eclipse.jdt.annotation.Nullable;
 
-import ch.njol.skript.variables.Variables;
-import ch.njol.util.Math2;
-import ch.njol.yggdrasil.Fields;
+import java.io.NotSerializableException;
+import java.io.StreamCorruptedException;
+import java.util.regex.Matcher;
+import java.util.regex.Pattern;
 
 public class ColorRGB implements Color {
-	
+
+	private static final Pattern RGB_PATTERN = Pattern.compile("(?>rgb|RGB) (\\d+), (\\d+), (\\d+)");
+
 	private org.bukkit.Color bukkit;
 	@Nullable
 	private DyeColor dye;
@@ -56,21 +59,21 @@ public DyeColor asDyeColor() {
 
 	@Override
 	public String getName() {
-		return "RED:" + bukkit.getRed() + ", GREEN:" + bukkit.getGreen() + ", BLUE:" + bukkit.getBlue();
+		return "rgb " + bukkit.getRed() + ", " + bukkit.getGreen() + ", " + bukkit.getBlue();
 	}
-	
+
+	@Nullable
 	public static ColorRGB fromString(String string) {
-		String[] split = string.split(", ");
-		int red = NumberUtils.toInt(split[0].replace("RED:", ""));
-		int green = NumberUtils.toInt(split[1].replace("GREEN:", ""));
-		int blue = NumberUtils.toInt(split[2].replace("BLUE:", ""));
-		return new ColorRGB(red, green, blue);
-	}
-	
-	public static boolean isRGBColor(String string) {
-		return string.startsWith("RED:");
+		Matcher matcher = RGB_PATTERN.matcher(string);
+		if (!matcher.matches())
+			return null;
+		return new ColorRGB(
+			NumberUtils.toInt(matcher.group(1)),
+			NumberUtils.toInt(matcher.group(2)),
+			NumberUtils.toInt(matcher.group(3))
+		);
 	}
-	
+
 	@Override
 	public Fields serialize() throws NotSerializableException {
 		return new Fields(this, Variables.yggdrasil);