hello

.gitignore

@@ -1,4 +1,5 @@
-/.metadata/
+*.DS_Store
+*.metadata/
 *.class
 /GameProject/doc/
 /GameProject/log/

GameProject/.classpath

@@ -1,8 +1,11 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <classpath>
 	<classpathentry kind="src" path="src"/>
-	<classpathentry kind="con" path="org.eclipse.jdt.launching.JRE_CONTAINER"/>
-	<classpathentry kind="con" path="org.eclipse.jdt.junit.JUNIT_CONTAINER/5"/>
+	<classpathentry kind="con" path="org.eclipse.jdt.launching.JRE_CONTAINER">
+		<attributes>
+			<attribute name="module" value="true"/>
+		</attributes>
+	</classpathentry>
 	<classpathentry kind="lib" path="lib/apache-log4j-2.13.3-bin/log4j-1.2-api-2.13.3.jar"/>
 	<classpathentry kind="lib" path="lib/apache-log4j-2.13.3-bin/log4j-api-2.13.3.jar"/>
 	<classpathentry kind="lib" path="lib/apache-log4j-2.13.3-bin/log4j-core-2.13.3.jar"/>

GameProject/src/base/GameLoop.java

@@ -217,8 +217,8 @@ public class GameLoop {
 
 
   /**
-   * main to start the whole application.
-   * initializes the {@link #levels} ArrayList of Playground instances (levels) to be played with one level {@link SpaceInvadersLevel} in constructor of {@link #GameLoop}.
+   * main to start the whole application. It calls. {@link #runGame(String[])}.
+   * (levels are automatically added/loaded by constructor of {@link #GameLoop}).
    * 
    * @param args Java default command line args, forwarded to {@link #runGame(String[])}
    * @throws IOException in case highscore.txt cannot be written.

GameProject/src/controller/CollisionAwareEgoController.java

@@ -37,6 +37,9 @@ public class CollisionAwareEgoController extends EgoController {
     this.shot = soundOnShot;
   }
 
+  /**
+   * Copies current values of x,y position and speed vx,vy into attributes. These can be restored by call to {@link #restoreDynamicState()}.
+   */
   public void saveDynamicState() {
     this.savex = this.getX();
     this.savey = this.getY();
@@ -45,6 +48,10 @@ public class CollisionAwareEgoController extends EgoController {
   }
 
 
+  /**
+   * Restores formally saved values of x,y position and speed vx,vy from attributes back to the ego object. 
+   * These values should have been stored before by a call to {@link #saveDynamicState()}, otherwise all values will be 0.00.
+   */
   public void restoreDynamicState() {
     this.setX(savex);
     this.setY(savey);
@@ -53,6 +60,10 @@ public class CollisionAwareEgoController extends EgoController {
   }
 
 
+  /**
+   * extends parent class implementation by a check whether or not the ego object collides with any other "obstacle" object.
+   * If yes, the position stays fixed (by using {@link #saveDynamicState()} and {@link #restoreDynamicState()}.
+   */
   public boolean stopObject() {
     boolean s = super.stopObject();
 
@@ -73,6 +84,9 @@ public class CollisionAwareEgoController extends EgoController {
     return s;
   }
 
+  /**
+   * calls superclass {@link EgoController#onSpace(KeyEvent, GameObject)} only, if the time elapsed since last pressing of space is above 0.1 ms.
+   */
   public void onSpace(KeyEvent e, GameObject ego) {
     double cgt = ego.getGameTime();
     if ((cgt - this.lastSpaceAt) > 0.1) {

GameProject/src/controller/EgoController.java

@@ -42,26 +42,51 @@ public class EgoController extends ObjectController {
   }
 
 
+  /**
+   * moves ego up by {@link SpaceInvadersLevel#EGOSPEED}.
+   * @param kc  KeyEvent to process (ignored)
+   * @param ego the ego object
+   */
   public void onUp(KeyEvent kc, GameObject ego) {
     ego.setVX(0.0);
     ego.setVY(-SpaceInvadersLevel.EGOSPEED);
   }
 
+  /**
+   * moves ego down by {@link SpaceInvadersLevel#EGOSPEED}.
+   * @param kc  KeyEvent to process (ignored)
+   * @param ego the ego object
+   */
   public void onDown(KeyEvent kc, GameObject ego) {
     ego.setVX(0.0);
     ego.setVY(SpaceInvadersLevel.EGOSPEED);
   }
 
+  /**
+   * moves ego left by {@link SpaceInvadersLevel#EGOSPEED}.
+   * @param kc  KeyEvent to process (ignored)
+   * @param ego the ego object
+   */
   public void onLeft(KeyEvent kc, GameObject ego) {
     ego.setVY(0.0);
     ego.setVX(-SpaceInvadersLevel.EGOSPEED);
   }
 
+  /**
+   * moves ego right by {@link SpaceInvadersLevel#EGOSPEED}.
+   * @param kc  KeyEvent to process (ignored)
+   * @param ego the ego object
+   */
   public void onRight(KeyEvent kc, GameObject ego) {
     ego.setVY(0.0);
     ego.setVX(SpaceInvadersLevel.EGOSPEED);
   }
 
+  /** 
+   * sets speed to 0.0
+   * @param kc  KeyEvent to process (ignored)
+   * @param ego the ego object
+   */
   public void onStop(KeyEvent kc, GameObject ego) {
     ego.setVY(0.0);
     ego.setVX(0.0);
@@ -72,7 +97,7 @@ public class EgoController extends ObjectController {
 
   /** checks the position and respects level boundaries and own radius or width/height set on constructor. 
    * 
-   * @return true if the object reached the boundaries of the level, false otherwise
+   * @return true if the object reached the boundaries of the level, false otherwise.
    */
   public boolean stopObject() {
     // check whether ego object is at level boundaries
@@ -93,7 +118,7 @@ public class EgoController extends ObjectController {
   }
 
 
-  /** behavior for shooting on key space
+  /** behavior for shooting on key space. Creates a new shot using {#link SimpleShotController} with a {@link RectObject}.
    * 
    * @param e KeyEvent of the space key
    * @param ego EgoObject instance (used to determine position of shot object's start)
@@ -119,7 +144,7 @@ public class EgoController extends ObjectController {
 
 
   /**
-   * updates position based on key events (mouse currently ignored)
+   * updates position based on key events (mouse currently ignored).
    */
   public void updateObject() {
 
@@ -141,9 +166,9 @@ public class EgoController extends ObjectController {
       }
 
       /**
-       * Generelle Idee: Wenn eine Taste gedrückt wird wird sie gespeichert. wenn die zuvor
+       * Generelle Idee: Wenn eine Taste gedrückt wird wird sie gespeichert. wenn die zuvor
        * gespeicherte Taste wieder losgelassen wird stoppt das Ego-Objekt. Falls vor dem Loslassen
-       * eine andere Taste gedrückt wird, wird diese gespeichert und die alte vergessen. Dh das
+       * eine andere Taste gedrückt wird, wird diese gespeichert und die alte vergessen. Dh das
        * loslassen der alten Taste stoppt das Objekt nicht. Spezialfall: space, das loslassen von
        * space stoppt das Objekt nicht!
        */
@@ -154,8 +179,8 @@ public class EgoController extends ObjectController {
       }
 
       /**
-       * Nur eine losgelassene Taste die auch vorher gedrückt wurde stoppt das Objekt. Eine
-       * losgelassene Taste die nicht vorher gedrückt wurde bzw vergessen wurde stoppt das Objekt
+       * Nur eine losgelassene Taste die auch vorher gedrückt wurde stoppt das Objekt. Eine
+       * losgelassene Taste die nicht vorher gedrückt wurde bzw vergessen wurde stoppt das Objekt
        * nicht
        */
       if (released == true) {

GameProject/src/log4j2.xml

@@ -7,7 +7,7 @@
 			<PatternLayout pattern="%d %-5level %logger{36} - %msg%n" />
 		</Console>
 		
-		<File name="File" fileName="log\log4j.log">
+		<File name="File" fileName="log/log4j.log">
 			<PatternLayout pattern="%d %-5level %logger{36} - %msg%n" />
 		</File>
 		

GameProject/src/playground/Level2.java

@@ -3,7 +3,7 @@ package playground;
 
 
 /**
- * extends extends {@link SpaceInvadersLevel} with a different startup message.
+ * extends {@link SpaceInvadersLevel} with a different startup message.
  */
 public class Level2 extends SpaceInvadersLevel {
 

GameProject/src/playground/Level4.java

@@ -10,7 +10,7 @@ import org.apache.logging.log4j.Logger;
 
 
 /**
- * extends extends {@link SpaceInvadersLevel}
+ * extends {@link SpaceInvadersLevel}
  * <ul>
  * <li>Hit aliens twice to kill them
  * <li>they say AUA when not destroyed

GameProject/src/playground/SpaceInvadersLevelTest.java

@@ -1,81 +0,0 @@
-package playground;
-
-import static org.junit.Assert.assertTrue;
-import java.awt.Color;
-import org.junit.jupiter.api.AfterAll;
-import org.junit.jupiter.api.BeforeAll;
-import org.junit.jupiter.api.Test;
-import gameobjects.EgoObject;
-import gameobjects.GameObject;
-import gameobjects.RectObject;
-
-/**
- * Tests {@link SpaceInvadersLevel} for
- * <ol>
- * <li>calcEnemySpeedX() returns the same value as constant SpaceInvadersLevel.ENEMYSPEEDX
- * <li>calcEnemySpeedY() returns the same value as constant SpaceInvadersLevel.ENEMYSPEEDY
- * <li>calcNrEnemies() returns the same value as constant SpaceInvadersLevel.NR_ENEMIES
- * <li>actionIfEnemyIsHit() adds 200 points to score
- * <li>actionIfEgoObjectIsHit() reduces number of lives (egoLives)
- * </ol>
- * @author jkonert
- *
- */
-class SpaceInvadersLevelTest {
-
-  private static SpaceInvadersLevel myLevel;
-
-  @BeforeAll
-  static void setUpBeforeClass() throws Exception {
-    myLevel = new SpaceInvadersLevel();
-    SpaceInvadersLevel.setGlobalFlag("egoLives",  5);
-    SpaceInvadersLevel.setGlobalFlag("points",  500);
-    SpaceInvadersLevel.setGlobalFlag("highscore", 5000);
-  }
-
-  @AfterAll
-  static void tearDownAfterClass() throws Exception {
-    // nothing 
-  }
-
-  @Test
-  void testCalcEnemySpeedX() {
-    assertTrue("EnemySpeedX is as in SpaceInvadersLevel defined", myLevel.calcEnemySpeedX() == SpaceInvadersLevel.ENEMYSPEEDX);
-  }
-
-  @Test
-  void testCalcEnemySpeedY() {
-    assertTrue("EnemySpeedY is as in SpaceInvadersLevel defined", myLevel.calcEnemySpeedY() == SpaceInvadersLevel.ENEMYSPEEDY);
-  }
-
-  @Test
-  void testCalcNrEnemies() {
-    assertTrue("NrOfEnemies is as in SpaceInvadersLevel defined", myLevel.calcNrEnemies() == SpaceInvadersLevel.NR_ENEMIES);
-  }
-
-  
-  @Test
-  void testActionIfEnemyIsHitPointsUp() {
-    Integer numPointsBefore = (Integer)Playground.getGlobalFlag("points");
-    GameObject dummyShot = new RectObject("shot1", myLevel, 0,0,0,0, 12, 12, Color.WHITE);
-    GameObject dummyEnemy = new RectObject("ego1", myLevel, 0,0,0,0, 12, 12, Color.BLACK);
-    myLevel.addObject(dummyShot);
-    myLevel.addObject(dummyEnemy);
-    myLevel.actionIfEnemyIsHit(dummyEnemy, dummyShot);;  // this is the call under test
-    Integer numPointsAfter = (Integer)Playground.getGlobalFlag("points");  // changed?
-    assertTrue("numPoints is up +200 after EnemyIsHit", numPointsAfter == numPointsBefore + 200); // points are set +200 , check.
-  }
-
-  @Test
-  void testActionIfEgoObjectIsHitLivesDown() {
-    Integer numLivesBefore = (Integer)Playground.getGlobalFlag("egoLives");
-    GameObject dummyShot = new RectObject("shot1", myLevel, 0,0,0,0, 12, 12, Color.RED);
-    GameObject dummyEgo = new EgoObject("ego1", myLevel, 0,0,0,0, 5);
-    myLevel.addObject(dummyShot);
-    myLevel.actionIfEgoObjectIsHit(dummyShot, dummyEgo);  // this is the call under test
-    Integer numLivesAfter = (Integer)Playground.getGlobalFlag("egoLives");  // changed?
-    assertTrue("numLives is reduced by one ifEgoIsHit", numLivesAfter == numLivesBefore - 1); // lives is reduced by one
-    
-  }
-
-}