Added JavaDoc to many classes

18 files changed, 39 insertions, 34 deletions

@@ -9,6 +9,7 @@ import com.fourisland.fourpuzzle.Direction;
 import java.awt.image.BufferedImage;
 
 /**
+ * BlankEventGraphic specifies an Event without an image.
  *
  * @author hatkirby
  */
@@ -10,6 +10,7 @@ import com.fourisland.fourpuzzle.gamestate.mapview.CharSet;
 import java.awt.image.BufferedImage;
 
 /**
+ * CharSetEventGraphic specifes an Event with an image from a <b>CharSet</b>.
  *
  * @author hatkirby
  */
@@ -9,6 +9,7 @@ import com.fourisland.fourpuzzle.Direction;
 import java.awt.image.BufferedImage;
 
 /**
+ * An EventGraphic specifies the image to be displayed on the map for an Event.
  *
  * @author hatkirby
  */
@@ -8,6 +8,9 @@ package com.fourisland.fourpuzzle.gamestate.mapview.event.movement;
 import com.fourisland.fourpuzzle.Direction;
 
 /**
+ * CustomMovementEvent takes an array of Directions and directions the event
+ * to move in each of them, one by one, returning to the top of the list when
+ * done.
  *
  * @author hatkirby
  */
@@ -8,6 +8,10 @@ package com.fourisland.fourpuzzle.gamestate.mapview.event.movement;
 import com.fourisland.fourpuzzle.Direction;
 
 /**
+ * A MovementType is an object that specifies the type of AI a non-hero event
+ * will have. Every tick when said event is not moving, MovementType's
+ * <b>nextMovement()</b> function will be invoked which should return the next
+ * direction for the event to move into.
  *
  * @author hatkirby
  */
@@ -9,6 +9,7 @@ import com.fourisland.fourpuzzle.Direction;
 import java.util.Random;
 
 /**
+ * RandomMovementType moves the event in random directions.
  *
  * @author hatkirby
  */
@@ -8,6 +8,7 @@ package com.fourisland.fourpuzzle.gamestate.mapview.event.movement;
 import com.fourisland.fourpuzzle.Direction;
 
 /**
+ * StayStillMovementType keeps the event stationary.
  *
  * @author hatkirby
  */
@@ -8,6 +8,8 @@ package com.fourisland.fourpuzzle.gamestate.mapview.event.precondition;
 import com.fourisland.fourpuzzle.Game;
 
 /**
+ * HeroInPartyPrecondition checks to see if a specific character is in the
+ * party.
  *
  * @author hatkirby
  */
@@ -1,30 +0,0 @@
-/*
- * To change this template, choose Tools | Templates
- * and open the template in the editor.
- */
-
-package com.fourisland.fourpuzzle.gamestate.mapview.event.precondition;
-
-import com.fourisland.fourpuzzle.Game;
-
-/**
- *
- * @author hatkirby
- */
-public class HeroLevelPrecondition implements Precondition {
-
-    private String heroName;
-    private int level;
-    
-    public HeroLevelPrecondition(String heroName, int level)
-    {
-        this.heroName = heroName;
-        this.level = level;
-    }
-    
-    public boolean match()
-    {
-        return (Game.getSaveFile().getParty().exists(heroName) && (Game.getSaveFile().getParty().get(heroName).getLevel() == level));
-    }
-    
-}
@@ -6,6 +6,12 @@
 package com.fourisland.fourpuzzle.gamestate.mapview.event.precondition;
 
 /**
+ * A Precondition is an object that helps <b>LayerEvent</b> to determine which
+ * of its (possibly many) <b>PossibleEvent</b>s is active. PossibleEvents can
+ * have Preconditions attached to them and when all Preconditions are fulfilled
+ * (determined by the <code>true</code> return value from <b>match()</b>) and
+ * there are not fulfilled PossibleEvents later in the queue, said PossibleEvent
+ * will be active.
  *
  * @author hatkirby
  */
@@ -8,6 +8,7 @@ package com.fourisland.fourpuzzle.gamestate.mapview.event.precondition;
 import com.fourisland.fourpuzzle.Game;
 
 /**
+ * SwitchPrecondition checks to see if a certain Switch is ON.
  *
  * @author hatkirby
  */
@@ -9,6 +9,8 @@ import com.fourisland.fourpuzzle.util.Comparison;
 import com.fourisland.fourpuzzle.Game;
 
 /**
+ * VariableNumberPrecondition compares a the value of a variable and a number
+ * together with a specified Comparison.
  *
  * @author hatkirby
  */
@@ -9,6 +9,8 @@ import com.fourisland.fourpuzzle.util.Comparison;
 import com.fourisland.fourpuzzle.Game;
 
 /**
+ * VariableVariablePrecondition compares two variables together with a specified
+ * Comparison.
  *
  * @author hatkirby
  */
@@ -9,7 +9,8 @@ import com.fourisland.fourpuzzle.Direction;
 import com.fourisland.fourpuzzle.gamestate.mapview.event.Event;
 
 /**
- *
+ * FaceMoveEvent turns the selected Event in the chosen direction.
+ * 
  * @author hatkirby
  */
 public class FaceMoveEvent implements MoveEvent {
@@ -9,7 +9,12 @@ import com.fourisland.fourpuzzle.gamestate.mapview.event.Event;
 import java.awt.Point;
 
 /**
- *
+ * LoopUntilCollisionMoveEvent takes an array of <b>MoveEvent</b>s and repeatedly
+ * executes them until the event in question collides into something. This is
+ * done by comparing the location of the event before and after the MoveEvents execute.
+ * Because of this, MoveEvent arrays that do not move the event will not block the
+ * game.
+ * 
  * @author hatkirby
  */
 public class LoopUntilCollisionMoveEvent implements MoveEvent {
@@ -9,7 +9,9 @@ package com.fourisland.fourpuzzle.gamestate.mapview.event.specialmove;
 import com.fourisland.fourpuzzle.gamestate.mapview.event.Event;
 
 /**
- *
+ * A MoveEvent is an object that tells the <b>MoveEvent()</b> SpecialEvent
+ * what to do.
+ * 
  * @author hatkirby
  */
 public interface MoveEvent {
@@ -11,6 +11,7 @@ import java.util.logging.Level;
 import java.util.logging.Logger;
 
 /**
+ * StepMoveEvent moves the event in the direction specified.
  *
  * @author hatkirby
  */
@@ -10,7 +10,8 @@ import java.util.logging.Level;
 import java.util.logging.Logger;
 
 /**
- *
+ * WaitMoveEvent pauses for the specifed amount of milliseconds.
+ * 
  * @author hatkirby
  */
 public class WaitMoveEvent implements MoveEvent {