Tarea 3

README.md

@@ -15,5 +15,40 @@ Broadly speaking for the combat the player has a group of characters to control
 enemies controlled by the computer.
 
 ---
+[comment]: <> (
+The rest of the documentation is left for the users of this template to complete
+What should the README contain?
+1. All instructions that you'd need in order to run the program.
+2. All the assumptions that I made.
+3. Brief explanation of the functioning and logic of the program.
+)
+How to run the program?
+------- 
+In "finalreality" package, you'll find an archive called "Main.java".
+This archive will contain several functions that will instantiate the
+classes on this program. Those include, the 5 types of playable characters (Engineer,
+BlackMage, Knight, Thief and WhiteMage), an enemy and the several weapons. If you
+run this Main, you will see in the output all the parameters printed according to
+its method, that way you'll see a demonstration of the program.
 
-**The rest of the documentation is left for the users of this template to complete**
+In order to play the game Final Fantasy, you need to follow certain turns. Those turns will
+be managed by a scheduler. To see the functioning of the scheduler, you can also
+run the class "TimerExample".
+
+This program only shows the model of the project, which shows the relations
+between classes, but it doesn't implement any of the methods and the restrictions
+related to which weapon can be equipped to which character are not considered, 
+ with the purpose of showing the functionality of the program.
+
+---
+Functioning and logic of the program
+-------
+To develop this simplified clone of Final Fantasy's combat, the architectural pattern
+Model-View-Controller was followed.
+
+The model of the program contains all the necessary classes and entities, which work as
+the basic structure of the project and its possible interactions. In this model, you'll
+find that there's an interface GameCharacter, which is implemented by all the characters and also guides their behavior in the game. In addition, all the characters (including the enemies)
+extends the abstract class AbstractCharacter.
+
+The View and the Controller are yet to be developed.

src/main/java/cl/uchile/dcc/finalreality/controller/GameController.java

@@ -0,0 +1,22 @@
+package cl.uchile.dcc.finalreality.controller;
+
+import cl.uchile.dcc.finalreality.model.character.GameCharacter;
+
+/**
+ * The game controller.
+ *
+ * Class that makes the logic conexion between the view and the model. It manages
+ * the game and makes all the operations needed.
+ */
+public class GameController {
+  private GameCharacter player1;
+  private GameCharacter player2;
+
+
+
+
+}
+
+
+
+

src/main/java/cl/uchile/dcc/finalreality/exceptions/InvalidStatValueException.java

@@ -1,5 +1,5 @@
 /*
- * "Final Reality" (c) by R8V and ~Your name~
+ * "Final Reality" (c) by R8V and Katia
  * "Final Reality" is licensed under a
  * Creative Commons Attribution 4.0 International License.
  * You should have received a copy of the license along with this
@@ -12,7 +12,7 @@
  * This error is used to represent an invalid stat value.
  *
  * @author <a href="https://github.com/r8vnhill">R8V</a>
- * @author ~Your name~
+ * @author Katia
  */
 public class InvalidStatValueException extends Exception {
 

src/main/java/cl/uchile/dcc/finalreality/exceptions/Require.java

@@ -1,5 +1,5 @@
 /*
- * "Final Reality" (c) by R8V and ~Your name~
+ * "Final Reality" (c) by R8V and Katia
  * "Final Reality" is licensed under a
  * Creative Commons Attribution 4.0 International License.
  * You should have received a copy of the license along with this
@@ -17,7 +17,7 @@
  * instantiated.
  *
  * @author <a href="https://github.com/r8vnhill">R8V</a>
- * @author ~Your name~
+ * @author Katia
  */
 public final class Require {
 

src/main/java/cl/uchile/dcc/finalreality/model/character/AbstractCharacter.java

@@ -13,16 +13,16 @@
  * An abstract class that holds the common behaviour of all the characters in the game.
  *
  * @author <a href="https://www.github.com/r8vnhill">R8V</a>
- * @author ~Your name~
+ * @author Katia
  */
 public abstract class AbstractCharacter implements GameCharacter {
 
-  private int currentHp;
-  protected int maxHp;
-  protected int defense;
+  protected int currentHp;
+  protected final int maxHp;
+  protected final int defense;
   protected final BlockingQueue<GameCharacter> turnsQueue;
   protected final String name;
-  private ScheduledExecutorService scheduledExecutor;
+  protected ScheduledExecutorService scheduledExecutor;
 
   /**
    * Creates a new character.
@@ -36,7 +36,7 @@ public abstract class AbstractCharacter implements GameCharacter {
    * @param turnsQueue
    *     the queue with the characters waiting for their turn
    */
-  protected AbstractCharacter(@NotNull String name, int maxHp, int defense,
+  public AbstractCharacter(@NotNull String name, int maxHp, int defense,
       @NotNull BlockingQueue<GameCharacter> turnsQueue) throws InvalidStatValueException {
     Require.statValueAtLeast(1, maxHp, "Max HP");
     Require.statValueAtLeast(0, defense, "Defense");
@@ -46,28 +46,9 @@ protected AbstractCharacter(@NotNull String name, int maxHp, int defense,
     this.turnsQueue = turnsQueue;
     this.name = name;
   }
-
+  
   @Override
-  public void waitTurn() {
-    scheduledExecutor = Executors.newSingleThreadScheduledExecutor();
-    if (this instanceof PlayerCharacter player) {
-      scheduledExecutor.schedule(
-          /* command = */ this::addToQueue,
-          /* delay = */ player.getEquippedWeapon().getWeight() / 10,
-          /* unit = */ TimeUnit.SECONDS);
-    } else {
-      var enemy = (Enemy) this;
-      scheduledExecutor.schedule(
-          /* command = */ this::addToQueue,
-          /* delay = */ enemy.getWeight() / 10,
-          /* unit = */ TimeUnit.SECONDS);
-    }
-  }
-
-  /**
-   * Adds this character to the turns queue.
-   */
-  private void addToQueue() {
+  public void addToQueue() {
     try {
       turnsQueue.put(this);
     } catch (Exception e) {

src/main/java/cl/uchile/dcc/finalreality/model/character/Enemy.java

@@ -4,26 +4,30 @@
 import cl.uchile.dcc.finalreality.exceptions.Require;
 import java.util.Objects;
 import java.util.concurrent.BlockingQueue;
+import java.util.concurrent.Executors;
+import java.util.concurrent.TimeUnit;
 import org.jetbrains.annotations.NotNull;
 
 /**
- * A class that holds all the information of a single enemy of the game.
+ * A class holds all the information of a single enemy of the game.
  *
  * @author <a href="https://www.github.com/r8vnhill">R8V</a>
- * @author ~Your name~
+ * @author Katia
  */
 public class Enemy extends AbstractCharacter {
+  protected final int damage;
 
-  private final int weight;
+  protected final int weight;
 
   /**
    * Creates a new enemy with a name, a weight and the queue with the characters ready to
    * play.
    */
   public Enemy(@NotNull final String name, final int weight, int maxHp, int defense,
-      @NotNull final BlockingQueue<GameCharacter> turnsQueue)
+               @NotNull final BlockingQueue<GameCharacter> turnsQueue, int damage)
       throws InvalidStatValueException {
     super(name, maxHp, defense, turnsQueue);
+    this.damage = damage;
     Require.statValueAtLeast(1, weight, "Weight");
     this.weight = weight;
   }
@@ -45,13 +49,31 @@ public boolean equals(final Object o) {
     }
     return hashCode() == enemy.hashCode()
         && name.equals(enemy.name)
-        && weight == enemy.weight
-        && maxHp == enemy.maxHp
-        && defense == enemy.defense;
+          && weight == enemy.weight
+          && maxHp == enemy.maxHp
+          && damage == enemy.damage
+          && defense == enemy.defense;
   }
 
   @Override
   public int hashCode() {
-    return Objects.hash(Enemy.class, name, weight, maxHp, defense);
+    return Objects.hash(Enemy.class, name, weight, maxHp, defense, damage);
+  }
+
+  @Override
+  public String toString() {
+    return "Enemy{weight=%d, maxHp=%d, defense=%d, damage=%d, name='%s'}"
+            .formatted(weight, maxHp, defense, damage, name);
+
+
+  }
+
+  @Override
+  public void waitTurn() {
+    this.scheduledExecutor = Executors.newSingleThreadScheduledExecutor();
+    this.scheduledExecutor.schedule(
+          /* command = */ this::addToQueue,
+          /* delay = */ this.getWeight() / 10,
+          /* unit = */ TimeUnit.SECONDS);
   }
 }

src/main/java/cl/uchile/dcc/finalreality/model/character/GameCharacter.java

@@ -7,9 +7,14 @@
  * A character can be controlled by the player or by the CPU (an enemy).
  *
  * @author <a href="https://www.github.com/r8vnhill">R8V</a>
- * @author ~Your name~
+ * @author Katia
  */
 public interface GameCharacter {
+
+  /**
+   * Adds this character to the turns queue.
+   */
+  public void addToQueue();
 
   /**
    * Sets a scheduled executor to make this character (thread) wait for {@code speed / 10}

src/main/java/cl/uchile/dcc/finalreality/model/character/player/AbstractPlayerCharacter.java

@@ -1,5 +1,5 @@
 /*
- * "Final Reality" (c) by R8V and ~Your name~
+ * "Final Reality" (c) by R8V and Katia
  * "Final Reality" is licensed under a
  * Creative Commons Attribution 4.0 International License.
  * You should have received a copy of the license along with this
@@ -11,24 +11,27 @@
 import cl.uchile.dcc.finalreality.exceptions.InvalidStatValueException;
 import cl.uchile.dcc.finalreality.model.character.AbstractCharacter;
 import cl.uchile.dcc.finalreality.model.character.GameCharacter;
+import cl.uchile.dcc.finalreality.model.weapon.AbstractWeapon;
 import cl.uchile.dcc.finalreality.model.weapon.Weapon;
 import java.util.concurrent.BlockingQueue;
+import java.util.concurrent.Executors;
+import java.util.concurrent.TimeUnit;
 import org.jetbrains.annotations.NotNull;
 
 /**
  * A class that holds all the information of a player-controlled character in the game.
  *
  * <p>All player characters have a {@code name}, a maximum amount of <i>hit points</i>
  * ({@code maxHp}), a {@code defense} value, a queue of {@link GameCharacter}s that are
- * waiting for their turn ({@code turnsQueue}), and can equip a {@link Weapon}.
+ * waiting for their turn ({@code turnsQueue}), and can equip a {@link AbstractWeapon}.
  *
  * @author <a href="https://www.github.com/r8vnhill">R8V</a>
- * @author ~Your name~
+ * @author Katia
  */
 public abstract class AbstractPlayerCharacter extends AbstractCharacter implements
     PlayerCharacter {
 
-  private Weapon equippedWeapon = null;
+  protected Weapon equippedWeapon = null;
 
   /**
    * Creates a new character.
@@ -48,14 +51,18 @@ protected AbstractPlayerCharacter(@NotNull final String name, final int maxHp,
       throws InvalidStatValueException {
     super(name, maxHp, defense, turnsQueue);
   }
-
-  @Override
-  public void equip(Weapon weapon) {
-    this.equippedWeapon = weapon;
-  }
-
+
   @Override
   public Weapon getEquippedWeapon() {
     return equippedWeapon;
   }
+
+  @Override
+  public void waitTurn() {
+    this.scheduledExecutor = Executors.newSingleThreadScheduledExecutor();
+    this.scheduledExecutor.schedule(
+          /* command = */ this::addToQueue,
+          /* delay = */ this.getEquippedWeapon().getWeight() / 10,
+          /* unit = */ TimeUnit.SECONDS);
+  }
 }