entwicklung/java: methods overviews (#138)

Author: TomekRD

hyperbook/book/entwicklung/java/Methoden/Coordinates.md

@@ -0,0 +1,146 @@
+# Methodendokumentation - Coordinates <!-- omit in toc -->
+
+## Inhaltsverzeichnis <!-- omit in toc -->
+- [Coordinates-Methoden](#coordinates-methoden)
+  - [**getX()**](#getx)
+  - [**getY()**](#gety)
+  - [**getNeighbors()**](#getneighbors)
+  - [**plus(Vector)**](#plusvector)
+  - [**minus(Vector)**](#minusvector)
+  - [**equals(Object)** (Coordinates)](#equalsobject-coordinates)
+
+
+## Coordinates-Methoden
+`Coordinates` repräsentiert zweidimensionale Koordinaten auf dem Spielfeld.
+
+---
+
+### **getX()**
+Gibt den Wert der X-Koordinate zurück.
+- **Rückgabetyp:** `int`
+
+```java
+.getX()
+```
+
+Das ganze Konstrukt:
+
+```java
+coordinates.getX()
+```
+
+Hier ein Code-Beispiel:
+
+```java
+int x = coordinates.getX();
+```
+
+---
+
+### **getY()**
+Gibt den Wert der Y-Koordinate zurück.
+- **Rückgabetyp:** `int`
+
+```java
+.getY()
+```
+
+Das ganze Konstrukt:
+
+```java
+coordinates.getY()
+```
+
+Hier ein Code-Beispiel:
+
+```java
+int y = coordinates.getY();
+```
+
+---
+
+### **getNeighbors()**
+Gibt die Koordinaten aller Nachbarfelder zurück (in einer Collection).
+- **Rückgabetyp:** `Collection<Coordinates>`
+
+```java
+.getNeighbors()
+```
+
+Das ganze Konstrukt:
+
+```java
+coordinates.getNeighbors()
+```
+
+Hier ein Code-Beispiel:
+
+```java
+Collection<Coordinates> neighbors = coordinates.getNeighbors();
+```
+
+---
+
+### **plus(Vector)**
+Addiert einen Vektor zu den Koordinaten und gibt das Ergebnis als neue Koordinaten zurück.
+- **Rückgabetyp:** `Coordinates`
+
+```java
+.plus(vector)
+```
+
+Das ganze Konstrukt:
+
+```java
+coordinates.plus(vector)
+```
+
+Hier ein Code-Beispiel:
+
+```java
+Coordinates newCoordinates = coordinates.plus(moveVector);
+```
+
+---
+
+### **minus(Vector)**
+Subtrahiert einen Vektor von den Koordinaten und gibt das Ergebnis als neue Koordinaten zurück.
+- **Rückgabetyp:** `Coordinates`
+
+```java
+.minus(vector)
+```
+
+Das ganze Konstrukt:
+
+```java
+coordinates.minus(vector)
+```
+
+Hier ein Code-Beispiel:
+
+```java
+Coordinates newCoordinates = coordinates.minus(moveVector);
+```
+
+---
+
+### **equals(Object)** (Coordinates)
+Vergleicht die Koordinaten mit einem anderen Objekt (normalerweise anderen Koordinaten).
+- **Rückgabetyp:** `boolean`
+
+```java
+.equals(object)
+```
+
+Das ganze Konstrukt:
+
+```java
+coordinates.equals(otherCoordinates)
+```
+
+Hier ein Code-Beispiel:
+
+```java
+boolean areEqual = coordinates.equals(new Coordinates(2, 3));
+```

hyperbook/book/entwicklung/java/Methoden/Direction.md

@@ -0,0 +1,100 @@
+# Methodendokumentation - Direction <!-- omit in toc -->
+
+## Inhaltsverzeichnis <!-- omit in toc -->
+- [Direction-Methoden](#direction-methoden)
+  - [**getDx()** (Direction)](#getdx-direction)
+  - [**getDy()** (Direction)](#getdy-direction)
+  - [**getVector()**](#getvector)
+  - [**equals(Object)** (Direction)](#equalsobject-direction)
+
+
+## Direction-Methoden
+`Direction` ist ein Enum, das die möglichen Bewegungsrichtungen im Spiel definiert.
+
+---
+
+### **getDx()** (Direction)
+Gibt den Wert für die X-Dimension der Bewegungsrichtung zurück (z.B. -1, 0 oder 1).
+- **Rückgabetyp:** `int`
+
+```java
+.getDx()
+```
+
+Das ganze Konstrukt:
+
+```java
+direction.getDx()
+```
+
+Hier ein Code-Beispiel:
+
+```java
+int dx = direction.getDx();
+```
+
+---
+
+### **getDy()** (Direction)
+Gibt den Wert für die Y-Dimension der Bewegungsrichtung zurück (z.B. -1, 0 oder 1).
+- **Rückgabetyp:** `int`
+
+```java
+.getDy()
+```
+
+Das ganze Konstrukt:
+
+```java
+direction.getDy()
+```
+
+Hier ein Code-Beispiel:
+
+```java
+int dy = direction.getDy();
+```
+
+---
+
+### **getVector()**
+Gibt den Vektor für eine Richtung zurück.
+- **Rückgabetyp:** `Vector`
+
+```java
+.getVector()
+```
+
+Das ganze Konstrukt:
+
+```java
+direction.getVector()
+```
+
+Hier ein Code-Beispiel:
+
+```java
+Vector moveVector = direction.getVector();
+```
+
+---
+
+### **equals(Object)** (Direction)
+Vergleicht die Bewegungsrichtung mit einem anderen Objekt (normalerweise einer anderen Richtung).
+- **Rückgabetyp:** `boolean`
+
+```java
+.equals(object)
+```
+
+Das ganze Konstrukt:
+
+```java
+direction.equals(otherDirection)
+```
+
+Hier ein Code-Beispiel:
+
+```java
+boolean areEqual = direction.equals(Direction.UP);
+```

hyperbook/book/entwicklung/java/Methoden/FieldState.md

@@ -0,0 +1,78 @@
+# Methodendokumentation - FieldState <!-- omit in toc -->
+
+## Inhaltsverzeichnis <!-- omit in toc -->
+- [FieldState-Methoden](#fieldstate-methoden)
+  - [**getSize()**](#getsize)
+  - [**getTeam()**](#getteam)
+  - [**isEmpty()**](#isempty)
+
+## FieldState-Methoden
+Der `FieldState` beschreibt den Zustand eines Feldes im Spiel. Es handelt sich um ein Enum, das verschiedene Zustände wie Fische unterschiedlicher Größe und Teams oder leere Felder repräsentiert.
+
+---
+
+### **getSize()**
+Gibt die Größe eines Fisches auf dem Feld zurück. Bei leeren Feldern oder der Krake kann die Rückgabe speziell behandelt werden (z.B. -1 oder 0).
+- **Rückgabetyp:** `int`
+
+```java
+.getSize()
+```
+
+Das ganze Konstrukt:
+
+```java
+fieldState.getSize()
+```
+
+Hier ein Code-Beispiel:
+
+```java
+int fishSize = fieldState.getSize();
+```
+
+---
+
+### **getTeam()**
+Gibt die Teamzugehörigkeit eines Fisches auf dem Feld zurück. Bei leeren Feldern oder der Krake wird möglicherweise `null` oder ein spezieller Wert zurückgegeben.
+- **Rückgabetyp:** `Team`
+
+```java
+.getTeam()
+```
+
+Das ganze Konstrukt:
+
+```java
+fieldState.getTeam()
+```
+
+Hier ein Code-Beispiel:
+
+```java
+Team fishTeam = fieldState.getTeam();
+```
+
+---
+
+### **isEmpty()**
+Überprüft, ob das Feld leer ist.
+- **Rückgabetyp:** `boolean`
+
+```java
+.isEmpty()
+```
+
+Das ganze Konstrukt:
+
+```java
+fieldState.isEmpty()
+```
+
+Hier ein Code-Beispiel:
+
+```java
+boolean isEmpty = fieldState.isEmpty();
+```
+
+---