Merge Changes from Chronoken

CHANGELOG.md

@@ -1,5 +1,9 @@
 # CHANGELOG
 
+# 7.0
+
+- Plugin cleanup and additional code changes
+
 # 6.2
 
  - Some specific internal FX fixes (please let me know if any effects look weird now)

EffectLib.doxyfile

@@ -38,7 +38,7 @@ PROJECT_NAME = EffectLib
 # could be handy for archiving the generated documentation or if some version
 # control system is used.
 
-PROJECT_NUMBER = 5.0
+PROJECT_NUMBER = 7.0
 
 # Using the PROJECT_BRIEF tag one can provide an optional one line description
 # for a project that appears at the top of each page and should give viewer a

pom.xml

@@ -3,7 +3,7 @@
     <modelVersion>4.0.0</modelVersion>
     <groupId>de.slikey</groupId>
     <artifactId>EffectLib</artifactId>
-    <version>6.2-SNAPSHOT</version>
+    <version>7.0</version>
 
     <name>EffectLib</name>
     <url>http://www.kevin-carstens.de/</url>
@@ -29,11 +29,12 @@
     <distributionManagement>
         <repository>
             <id>maven.elmakers.com</id>
-            <url>http://maven.elmakers.com/repository/</url>
+            <url>https://maven.elmakers.com/repository/</url>
         </repository>
+
         <snapshotRepository>
             <id>maven.elmakers.com</id>
-            <url>http://maven.elmakers.com/repository/</url>
+            <url>https://maven.elmakers.com/repository/</url>
         </snapshotRepository>
     </distributionManagement>
 
@@ -46,14 +47,12 @@
 
     <dependencies>
         <dependency>
-            <groupId>org.bukkit</groupId>
-            <artifactId>bukkit</artifactId>
-            <version>1.13-R0.1-SNAPSHOT</version>
-            <!-- for testing backwards-compat
-            <version>1.9-R0.1-SNAPSHOT</version>
-            -->
+            <groupId>org.spigotmc</groupId>
+            <artifactId>spigot-api</artifactId>
+            <version>1.16.4-R0.1-SNAPSHOT</version>
             <scope>provided</scope>
         </dependency>
+
         <dependency>
             <groupId>net.objecthunter</groupId>
             <artifactId>exp4j</artifactId>
@@ -75,16 +74,17 @@
             <plugin>
                 <groupId>org.apache.maven.plugins</groupId>
                 <artifactId>maven-compiler-plugin</artifactId>
-                <version>3.3</version>
+                <version>3.8.1</version>
                 <configuration>
-                    <source>1.6</source>
-                    <target>1.6</target>
+                    <source>7</source>
+                    <target>7</target>
                 </configuration>
             </plugin>
+
             <plugin>
                 <groupId>org.apache.maven.plugins</groupId>
                 <artifactId>maven-shade-plugin</artifactId>
-                <version>1.5</version>
+                <version>3.2.4</version>
                 <executions>
                     <execution>
                         <phase>package</phase>

src/main/java/de/slikey/effectlib/Effect.java

@@ -1,20 +1,31 @@
 package de.slikey.effectlib;
 
-import de.slikey.effectlib.util.DynamicLocation;
+import java.util.List;
+import java.util.ArrayList;
+import java.util.concurrent.ThreadLocalRandom;
 
-import org.bukkit.Particle;
 import org.bukkit.Color;
-import org.bukkit.Location;
 import org.bukkit.Material;
+import org.bukkit.Particle;
+import org.bukkit.Location;
+import org.bukkit.util.Vector;
 import org.bukkit.entity.Entity;
 import org.bukkit.entity.Player;
-import org.bukkit.util.Vector;
+import org.bukkit.configuration.ConfigurationSection;
 
-import java.util.ArrayList;
-import java.util.List;
+import de.slikey.effectlib.util.RandomUtils;
+import de.slikey.effectlib.util.DynamicLocation;
 
 public abstract class Effect implements Runnable {
 
+    /**
+     * Sub effect
+     * This will play a subeffect on the effect location
+     */
+    private String subEffectClass = null;
+    public ConfigurationSection subEffect = null;
+
+
     /**
      * Handles the type, the effect is played.
      *
@@ -28,6 +39,9 @@ public abstract class Effect implements Runnable {
      */
     public Color color = null;
 
+    public List<Color> colorList = null;
+    public String colors = null;
+
     /**
      * This can be used to give particles a set speed when spawned.
      * This will not work with colored particles.
@@ -74,6 +88,11 @@ public abstract class Effect implements Runnable {
      */
     public Integer duration = null;
 
+    /**
+     * Probability that this effect will play on each iteration
+     */
+    public double probability = 1;
+
     /**
      * Callback to run, after effect is done.
      *
@@ -192,24 +211,43 @@ public abstract class Effect implements Runnable {
 
     private boolean done = false;
 
+    private long startTime;
+
     public Effect(EffectManager effectManager) {
-        if (effectManager == null) {
-            throw new IllegalArgumentException("EffectManager cannot be null!");
-        }
+        if (effectManager == null) throw new IllegalArgumentException("EffectManager cannot be null!");
+
         this.effectManager = effectManager;
-        this.visibleRange = effectManager.getParticleRange();
+        visibleRange = effectManager.getParticleRange();
+    }
+
+    protected void initialize() {
+        if (period < 1) period = 1;
+
+        if (colors != null) {
+            colorList = new ArrayList<>();
+            String[] args = colors.split(",");
+            if (args.length >= 1) {
+                for (String str : args) {
+                    try {
+                        int rgb = Integer.parseInt(str.trim().replace("#", ""), 16);
+                        colorList.add(Color.fromRGB(rgb));
+                    } catch (NumberFormatException ignored) {}
+                }
+            }
+        }
+
+        if (subEffect != null) {
+            subEffectClass = subEffect.getString("subEffectClass");
+        }
     }
 
     public final void cancel() {
         cancel(true);
     }
 
     public final void cancel(boolean callback) {
-        if (callback) {
-            done();
-        } else {
-            done = true;
-        }
+        if (callback) done();
+        else done = true;
     }
 
     public final boolean isDone() {
@@ -231,22 +269,23 @@ public final void run() {
             return;
         }
         if (done) {
+            effectManager.removeEffect(this);
             return;
         }
+
         try {
-            onRun();
+            if (RandomUtils.checkProbability(probability)) {
+                onRun();
+            }
         } catch (Exception ex) {
             done();
             effectManager.onError(ex);
         }
+
         if (type == EffectType.REPEATING) {
-            if (iterations == -1) {
-                return;
-            }
+            if (iterations == -1) return;
             iterations--;
-            if (iterations < 1) {
-                done();
-            }
+            if (iterations < 1) done();
         } else {
             done();
         }
@@ -257,7 +296,7 @@ public final void run() {
      * state can be reset.
      */
     protected void reset() {
-        this.done = false;
+        done = false;
     }
 
     public void prepare() {
@@ -323,17 +362,12 @@ public final Location getTarget() {
      * Set the Location this Effect is centered on.
      */
     public void setDynamicOrigin(DynamicLocation location) {
-        if (location == null) {
-            throw new IllegalArgumentException("Origin Location cannot be null!");
-        }
+        if (location == null) throw new IllegalArgumentException("Origin Location cannot be null!");
         origin = location;
 
-        if (offset != null) {
-            origin.addOffset(offset);
-        }
-        if (relativeOffset != null) {
-            origin.addRelativeOffset(relativeOffset);
-        }
+        if (offset != null) origin.addOffset(offset);
+        if (relativeOffset != null) origin.addRelativeOffset(relativeOffset);
+
         origin.setDirectionOffset(yawOffset, pitchOffset);
         origin.setYaw(yaw);
         origin.setPitch(pitch);
@@ -347,32 +381,22 @@ public void setDynamicOrigin(DynamicLocation location) {
      */
     public void setDynamicTarget(DynamicLocation location) {
         target = location;
-        if (target != null && targetOffset != null) {
-            target.addOffset(targetOffset);
-        }
-        if (target != null) {
-            target.setUpdateLocation(updateLocations);
-            target.setUpdateDirection(updateDirections);
-        }
+        if (target != null && targetOffset != null) target.addOffset(targetOffset);
+        if (target == null) return;
+        target.setUpdateLocation(updateLocations);
+        target.setUpdateDirection(updateDirections);
     }
 
     protected final boolean validate() {
         // Check if the origin and target entities are present
-        if (disappearWithOriginEntity && (origin != null && !origin.hasValidEntity())) {
-            return false;
-        }
-
-        if (disappearWithTargetEntity && (target != null && !target.hasValidEntity())) {
-            return false;
-        }
-
+        if (disappearWithOriginEntity && (origin != null && !origin.hasValidEntity())) return false;
+        if (disappearWithTargetEntity && (target != null && !target.hasValidEntity())) return false;
+
         // Check for a valid Location
         updateLocation();
         updateTarget();
         Location location = getLocation();
-        if (location == null) {
-            return false;
-        }
+        if (location == null) return false;
         if (autoOrient) {
             Location targetLocation = target == null ? null : target.getLocation();
             if (targetLocation != null) {
@@ -387,45 +411,50 @@ protected final boolean validate() {
 
     protected void updateDuration() {
         if (duration != null) {
-            if (period < 1) {
-                period = 1;
-            }
+            if (period < 1) period = 1;
             iterations = duration / period / 50;
         }
         maxIterations = iterations;
     }
 
     protected void updateLocation() {
-        if (origin != null) {
-            origin.update();
-        }
+        if (origin != null) origin.update();
     }
 
     protected void updateTarget() {
-        if (target != null) {
-            target.update();
-        }
+        if (target != null) target.update();
     }
 
     protected void display(Particle effect, Location location) {
-        display(effect, location, this.color);
+        display(effect, location, color);
     }
 
     protected void display(Particle particle, Location location, Color color) {
         display(particle, location, color, particleData != 0 ? particleData : speed, particleCount);
     }
 
     protected void display(Particle particle, Location location, float speed, int amount) {
-        display(particle, location, this.color, speed, amount);
+        display(particle, location, color, speed, amount);
     }
 
     protected void display(Particle particle, Location location, Color color, float speed, int amount) {
-        if (targetPlayers == null && targetPlayer != null) {
-            targetPlayers = new ArrayList<Player>();
-            targetPlayers.add(targetPlayer);
+        // display particles only when particleCount is equal or more than 0
+        if (particleCount >= 0) {
+            if (targetPlayers == null && targetPlayer != null) {
+                targetPlayers = new ArrayList<>();
+                targetPlayers.add(targetPlayer);
+            }
+
+            Color currentColor = color;
+            if (colorList != null && !colorList.isEmpty()) {
+                currentColor = colorList.get(ThreadLocalRandom.current().nextInt(colorList.size()));
+            }
+
+            effectManager.display(particle, location, particleOffsetX, particleOffsetY, particleOffsetZ, speed, amount,
+                    particleSize, currentColor, material, materialData, visibleRange, targetPlayers);
         }
-        effectManager.display(particle, location, particleOffsetX, particleOffsetY, particleOffsetZ, speed, amount,
-                particleSize, color, material, materialData, visibleRange, targetPlayers);
+
+        if (subEffectClass != null) effectManager.start(subEffectClass, subEffect, location);
     }
 
     private void done() {
@@ -466,6 +495,20 @@ public void setTargetLocation(Location location) {
         target = new DynamicLocation(location);
     }
 
-    public Player getTargetPlayer() {return this.targetPlayer; }
-    public void setTargetPlayer(Player p){ this.targetPlayer = p; }
+    public Player getTargetPlayer() {
+    	return targetPlayer;
+    }
+
+    public void setTargetPlayer(Player p) {
+    	targetPlayer = p;
+    }
+
+    public long getStartTime() {
+        return startTime;
+    }
+
+    public void setStartTime(long startTime) {
+        this.startTime = startTime;
+    }
+
 }