From 326d37f28a3fa5dbb7363c26d5fa54200b6045d2 Mon Sep 17 00:00:00 2001
From: nathank33 <nathanbraunguitar@gmail.com>
Date: Sun, 1 Feb 2015 11:16:18 -0800
Subject: [PATCH] LavaFlow: Moved everything to instance variables, and cleaned
 up

Lightning: Code cleanup
---
 .../ProjectKorra/firebending/Lightning.java   | 64 +++++++++++++------
 1 file changed, 45 insertions(+), 19 deletions(-)

diff --git a/src/com/projectkorra/ProjectKorra/firebending/Lightning.java b/src/com/projectkorra/ProjectKorra/firebending/Lightning.java
index 6c59e2f8..c9b6d6a1 100644
--- a/src/com/projectkorra/ProjectKorra/firebending/Lightning.java
+++ b/src/com/projectkorra/ProjectKorra/firebending/Lightning.java
@@ -195,7 +195,12 @@ public class Lightning {
 		}
 	}
 	
-	/** Checks if a block is transparent, also considers the ARC_ON_ICE config option **/
+	/** 
+	 * Checks if a block is transparent, also considers the ARC_ON_ICE config option.
+	 * @param player the player that is viewing the block
+	 * @param block the block
+	 * @return true if the block is transparent
+	 */
 	public boolean isTransparent(Player player, Block block) {
 		if (Arrays.asList(Methods.transparentToEarthbending).contains(block.getTypeId())) {
 			if(Methods.isRegionProtectedFromBuild(player, "Lightning", block.getLocation()))
@@ -241,7 +246,9 @@ public class Lightning {
 		}
 	}
 
-	/** Removes the instance of this ability and cancels any current runnables **/
+	/** 
+	 * Removes the instance of this ability and cancels any current runnables 
+	 */
 	public void removeWithTasks() {
 		for(int i = 0; i < tasks.size(); i++) {
 			tasks.get(i).cancel();
@@ -250,11 +257,15 @@ public class Lightning {
 		remove();
 	}
 	
-	/** Removes this ability instance **/
	public void remove() {
+	/** 
+	 * Removes this ability instance 
+	 */
	public void remove() {
 		instances.remove(this);
 	}
 	
-	/** Removes every instance of this ability **/
+	/** 
+	 * Removes every instance of this ability
+	 */
 	public static void removeAll() {
 		for (int i = 0; i < instances.size(); i++) {
 			instances.get(i).remove();
@@ -262,13 +273,19 @@ public class Lightning {
 		}
 	}
 	
-	/** Progresses every instance of this ability by 1 tick **/
+	/** 
+	 * Progresses every instance of this ability by 1 tick 
+	 */
 	public static void progressAll() {
 		for (int i = 0; i < instances.size(); i++)
 			instances.get(i).progress();
 	}
 	
-	/** Returns an instance of this ability if it was initialized by player **/
+	/**
+	 * Returns an instance of this ability if it was initialized by player 
+	 * @param player that created the instance
+	 * @return the ability
+	 */
 	public static Lightning getLightning(Player player) {
 		for(Lightning light : instances) {
 			if(light.player == player)
@@ -277,28 +294,35 @@ public class Lightning {
 		return null;
 	}
 	
-	/** Checks if a location contains an ice block **/
+	/**
+	 * Checks if a location contains an ice block
+	 * @param loc the location to check
+	 * @return true if it is ice
+	 */
 	public static boolean isIce(Location loc) {
 		Material mat = loc.getBlock().getType();
 		return mat == Material.ICE || mat == Material.PACKED_ICE;
 	}
 
-	/** Checks if a location contains a water block **/
+	/**
+	 * Checks if a location contains a water block
+	 * @param loc the location to check
+	 * @return true if it is water
+	 */
 	public static boolean isWater(Location loc) {
 		Material mat = loc.getBlock().getType();
 		return mat == Material.WATER || mat == Material.STATIONARY_WATER;
 	}
 	
-	/** Checks if a location is ice or water **/
+	/**
+	 * Checks if a location is ice or water
+	 * @param loc the location to check
+	 * @return true if it is water or ice
+	 */
 	public static boolean isWaterOrIce(Location loc) {
 		return isIce(loc) || isWater(loc);
 	}
 	
-	public static String getDescription() {
-		return "Hold sneak while selecting this ability to charge up a lightning strike. Once "
-				+ "charged, release sneak to discharge the lightning to the targetted location.";
-	}
-	
 	/** An Arc represents a Lightning arc for the specific ability.
 	 * These Arcs contain a list of Particles that are used to display
 	 * the entire arc. Arcs can also generate a list of subarcs that
@@ -380,7 +404,9 @@ public class Lightning {
 			return arcs;
 		}
 		
-		/** Stops this Arc from further animating or doing damage. **/
+		/** 
+		 * Stops this Arc from further animating or doing damage.
+		 */
 		public void cancel() {
 			for(int i = 0; i < particles.size(); i++) {
 				particles.get(i).cancel();
@@ -391,12 +417,10 @@ public class Lightning {
 			}
 		}
 		
-		/** Gets every point that makes up this arc. **/
 		public ArrayList<Location> getPoints() {
 			return points;
 		}
 		
-		/** Below are accessor and mutators**/
 		public void setPoints(ArrayList<Location> points) {
 			this.points = points;
 		}
@@ -437,7 +461,8 @@ public class Lightning {
 	
 	/** Represents a Lightning Arc Point particle animation.
 	 * 	This basically just holds a location and counts the
-	 * 	amount of times that a particle has been animated. **/
+	 * 	amount of times that a particle has been animated. 
+	 * **/
 	public class AnimLocation {
 		private Location loc;
 		private int animCounter;
@@ -470,7 +495,8 @@ public class Lightning {
 	 * These LightningParticles do the actual checking for player collision
 	 * and handle damaging any entities. These Runnables also
 	 * check to see if they reach water, in which case they will generate
-	 * subarcs to branch out.**/
+	 * subarcs to branch out.
+	 * **/
 	public class LightningParticle extends BukkitRunnable {
 		private Arc arc;
 		private Location loc;