From 3a8a5deda73da61ad751f34092bf924f7fe9859a Mon Sep 17 00:00:00 2001 From: Makussu Date: Sat, 8 Jun 2024 00:39:15 +0200 Subject: [PATCH] add javadocs to all classes --- readme.org | 6 +++--- src/AniMove.java | 3 +++ src/AniShrink.java | 3 +++ src/Animation.java | 3 +++ src/AuraBubble.java | 3 +++ src/AuraFail.java | 3 +++ src/AuraFight.java | 5 ++++- src/Drawable.java | 3 +++ src/Fenster.java | 3 +++ src/Fight.java | 4 ++++ src/FightScreen.java | 3 +++ src/GameScreen.java | 3 +++ src/Health.java | 3 +++ src/Position.java | 3 +++ src/Save.java | 3 +++ src/Skill.java | 3 +++ src/StartScreen.java | 3 +++ src/State.java | 3 +++ src/Talkable.java | 2 +- src/Tiles.java | 7 +++++-- src/Tritt.java | 3 +++ src/UI.java | 3 +++ 22 files changed, 68 insertions(+), 7 deletions(-) diff --git a/readme.org b/readme.org index 84e9162..299c14b 100644 --- a/readme.org +++ b/readme.org @@ -1,12 +1,12 @@ * Objektorientiertes Design ** DONE min. 10 Klassen -** TODO min. zwei Vererbungen mit einer Tiefe von drei +** DONE min. zwei Vererbungen mit einer Tiefe von drei ** DONE Anwendung von Polymorphie ** DONE Verwendung eines Interfaces -** TODO Anwendung eines Patterns (z.B. Singelton) +** DONE Anwendung eines Patterns (z.B. Singelton) * Spielbarkeit ** DONE User Interaktion mit Maus oder Tastatur -** TODO Ziel und Verbesserungsmöglichkeit (z.B. durch Punkte) +** DONE Ziel und Verbesserungsmöglichkeit (z.B. durch Punkte) ** TODO Persistierung des Spielstandes (abspeichern) * Dokumentation ** TODO Kurze Präsentation (10 min) im letzten Labortermin (eine pro Gruppe) diff --git a/src/AniMove.java b/src/AniMove.java index f29596e..c1b8f6b 100644 --- a/src/AniMove.java +++ b/src/AniMove.java @@ -1,5 +1,8 @@ import processing.core.PVector; +/** + * An animation which moves an entity somewhere over an amount of frames + */ public class AniMove extends Animation { public AniMove(Fenster window, Character player) { super(window, player); diff --git a/src/AniShrink.java b/src/AniShrink.java index fa7a678..443ffba 100644 --- a/src/AniShrink.java +++ b/src/AniShrink.java @@ -1,3 +1,6 @@ +/** + * An animation which shrinks a Character over an amount of frames. + */ public class AniShrink extends Animation { int numPoints = 50; public AniShrink(Fenster window, Character player) { diff --git a/src/Animation.java b/src/Animation.java index f60b07f..945f13c 100644 --- a/src/Animation.java +++ b/src/Animation.java @@ -1,5 +1,8 @@ import processing.core.PVector; +/** + * Shared code of the animations. + */ public class Animation { Fenster window; Character player; diff --git a/src/AuraBubble.java b/src/AuraBubble.java index 500f228..72ef504 100644 --- a/src/AuraBubble.java +++ b/src/AuraBubble.java @@ -2,6 +2,9 @@ import processing.core.PVector; import java.util.Random; +/** + * The Aura ball we can see and click in a fight. + */ public class AuraBubble { Fenster window; Random rand = new Random(); diff --git a/src/AuraFail.java b/src/AuraFail.java index e8894c2..045bf03 100644 --- a/src/AuraFail.java +++ b/src/AuraFail.java @@ -1,5 +1,8 @@ import processing.core.PVector; +/** + * A Auraball that shauld not be clicked. If clicked it will damage the player through the AuraFight. + */ public class AuraFail extends AuraBubble { public AuraFail(Fenster window) { super(window); diff --git a/src/AuraFight.java b/src/AuraFight.java index b27c3c5..f9c6155 100644 --- a/src/AuraFight.java +++ b/src/AuraFight.java @@ -1,4 +1,7 @@ -public class AuraFight extends Bubble{ +/** + * This basically is the fightscene and logic which generates the aura balls. + */ +public class AuraFight extends Bubble implements Drawable { Player player; Enemy enemy; AuraBubble my_aura = new AuraBubble(window); diff --git a/src/Drawable.java b/src/Drawable.java index 86cceb9..e5df275 100644 --- a/src/Drawable.java +++ b/src/Drawable.java @@ -1,3 +1,6 @@ +/** + * The objects that can draw onto the window. + */ public interface Drawable { public void draw(); } diff --git a/src/Fenster.java b/src/Fenster.java index 277fcbe..8e3f788 100644 --- a/src/Fenster.java +++ b/src/Fenster.java @@ -6,6 +6,9 @@ import java.util.ArrayList; import java.util.Arrays; +/** + * The window which holds all game information and draws. + */ public class Fenster extends PApplet { Player player; diff --git a/src/Fight.java b/src/Fight.java index c1ed458..f67b8a7 100644 --- a/src/Fight.java +++ b/src/Fight.java @@ -2,6 +2,10 @@ import processing.core.PApplet; import java.util.List; + +/** + * Unused old fighting logic. Replaced with AuraFight. + */ public class Fight extends Bubble { Player player; Enemy enemy; diff --git a/src/FightScreen.java b/src/FightScreen.java index eb12c7f..cd6ca4c 100644 --- a/src/FightScreen.java +++ b/src/FightScreen.java @@ -1,3 +1,6 @@ +/** + * State which holds the fightscene + */ public class FightScreen implements State { Fenster window; boolean isState = false; diff --git a/src/GameScreen.java b/src/GameScreen.java index 4f4d59d..3782f34 100644 --- a/src/GameScreen.java +++ b/src/GameScreen.java @@ -1,3 +1,6 @@ +/** + * Main game scene. + */ public class GameScreen implements State { Fenster window; boolean isState = false; diff --git a/src/Health.java b/src/Health.java index f454fb6..87cb726 100644 --- a/src/Health.java +++ b/src/Health.java @@ -1,3 +1,6 @@ +/** + * Interface for Character that have health. + */ public interface Health { diff --git a/src/Position.java b/src/Position.java index 5991acb..4800f43 100644 --- a/src/Position.java +++ b/src/Position.java @@ -1,5 +1,8 @@ import processing.core.PVector; +/** + * Class which holds a Characters position. It can translate and sync off and on-grid positions. + */ public class Position { Fenster window; float x, y; diff --git a/src/Save.java b/src/Save.java index 051327d..db806d3 100644 --- a/src/Save.java +++ b/src/Save.java @@ -1,5 +1,8 @@ import java.io.*; +/** + * Class for the savefile + */ public class Save { private static Save INSTANCE; diff --git a/src/Skill.java b/src/Skill.java index 7981d0d..2a8f4ba 100644 --- a/src/Skill.java +++ b/src/Skill.java @@ -1,3 +1,6 @@ +/** + * Currently unused Skill class which was the skeleton for Tritt. It could animate and calculate. + */ public class Skill { Fenster window; Character user; diff --git a/src/StartScreen.java b/src/StartScreen.java index 94f5e1e..c8ea332 100644 --- a/src/StartScreen.java +++ b/src/StartScreen.java @@ -1,5 +1,8 @@ import java.util.Arrays; +/** + * State which holds the starting screen with animations. + */ public class StartScreen implements State { Fenster window; boolean isState = false; diff --git a/src/State.java b/src/State.java index beb0037..613e01a 100644 --- a/src/State.java +++ b/src/State.java @@ -1,3 +1,6 @@ +/** + * Interface that defines what a state should be able to do. + */ public interface State { Fenster window = null; diff --git a/src/Talkable.java b/src/Talkable.java index 854284c..24ff1e3 100644 --- a/src/Talkable.java +++ b/src/Talkable.java @@ -1,7 +1,7 @@ import processing.core.PApplet; /** - * A Character we can talk to + * A Character we can talk to. */ public class Talkable extends Character implements Interactable{ Bubble bubble; diff --git a/src/Tiles.java b/src/Tiles.java index 8697a27..51c2c88 100644 --- a/src/Tiles.java +++ b/src/Tiles.java @@ -2,7 +2,10 @@ import java.util.ArrayList; import java.util.Arrays; import java.util.List; -public class Tiles { +/** + * This keeps and creates the tiles and information around them. Basically the level builder. + */ +public class Tiles implements Drawable { Fenster window; Cell[][] tileMap; float tilewidth; @@ -54,7 +57,7 @@ public class Tiles { /** * This will draw all cells and also redraw all talkable cells, to the bubble is displayed on top. */ - void draw() { + public void draw() { for(int i = 0; i < tileMap.length; i++) { for(int j = 0; j < tileMap[0].length; j++) { tileMap[i][j].draw(); diff --git a/src/Tritt.java b/src/Tritt.java index 50282ab..76a81bd 100644 --- a/src/Tritt.java +++ b/src/Tritt.java @@ -1,3 +1,6 @@ +/** + * Unused Skill which did basic damage and showed a neat animation. + */ public class Tritt extends Skill { boolean animating = false; diff --git a/src/UI.java b/src/UI.java index dbfcef8..945e7a6 100644 --- a/src/UI.java +++ b/src/UI.java @@ -1,6 +1,9 @@ import processing.core.PApplet; import processing.core.PShape; +/** + * Class that draws our UI. + */ public class UI { Fenster window;