Methodendokumentation - GameState (Spielstand)

Der gameState enthält alle wichtigen Parameter, die für Berechnungen benötigt werden. Auf ihm können verschiedene Methoden aufgerufen werden, um diese Parameter abzurufen.

Inhaltsverzeichnis

clone()

Erstellt eine tiefe Kopie des Spielstands.

Rückgabetyp: GameState

.clone()

Das ganze Konstrukt:

gameState.clone()

Hier ein Code-Beispiel:

GameState copiedState = gameState.clone();

equals(Object)

Vergleicht den Spielstand mit einem anderen Objekt.

Rückgabetyp: Boolean

.equals(object)

Das ganze Konstrukt:

gameState.equals(otherState)

Hier ein Code-Beispiel:

boolean areEqual = gameState.equals(otherState);

getBoard()

Gibt das Spielfeld aus dem Spielstand zurück.

Rückgabetyp: Board

.getBoard()

Das ganze Konstrukt:

gameState.getBoard()

Hier ein Code-Beispiel:

Board currentBoard = gameState.getBoard();

getCurrentColor()

Gibt die Farbe zurück, die gerade am Zug ist.

Rückgabetyp: Color

.getCurrentColor()

Das ganze Konstrukt:

gameState.getCurrentColor()

Hier ein Code-Beispiel:

Color currentColor = gameState.getCurrentColor();

getCurrentTeam()

Gibt das Team zurück, das gerade am Zug ist.

Rückgabetyp: Team

.getCurrentTeam()

Das ganze Konstrukt:

gameState.getCurrentTeam()

Hier ein Code-Beispiel:

Team currentTeam = gameState.getCurrentTeam();

getLastMove()

Gibt den letzten Zug des Gegners zurück.

Rückgabetyp: Move

.getLastMove()

Das ganze Konstrukt:

gameState.getLastMove()

Hier ein Code-Beispiel:

Move lastMove = gameState.getLastMove();

getLastMoveMono()

Gibt eine Map zurück, die für jede Farbe angibt, ob sie den letzten Zug ausgeführt hat (Monochrom-Information).

Rückgabetyp: HashMap<Color, Boolean>

.getLastMoveMono()

Das ganze Konstrukt:

gameState.getLastMoveMono()

Hier ein Code-Beispiel:

HashMap<Color, Boolean> lastMoveMono = gameState.getLastMoveMono();

getOrderedColors()

Gibt die Farben in ihrer Zugreihenfolge zurück.

Rückgabetyp: List<Color>

.getOrderedColors()

Das ganze Konstrukt:

gameState.getOrderedColors()

Hier ein Code-Beispiel:

List<Color> orderedColors = gameState.getOrderedColors();

getOtherTeam()

Gibt das Team zurück, das gerade nicht am Zug ist.

Rückgabetyp: Team

.getOtherTeam()

Das ganze Konstrukt:

gameState.getOtherTeam()

Hier ein Code-Beispiel:

Team otherTeam = gameState.getOtherTeam();

getPointsForTeam(ITeam)

Gibt die Punkte für das angegebene Team zurück.

Rückgabetyp: int

.getPointsForTeam(ITeam team)

Das ganze Konstrukt:

gameState.getPointsForTeam(team)

Hier ein Code-Beispiel:

int teamPoints = gameState.getPointsForTeam(blueTeam);

getRound()

Gibt die aktuelle Runde zurück.

Rückgabetyp: int

.getRound()

Das ganze Konstrukt:

gameState.getRound()

Hier ein Code-Beispiel:

int currentRound = gameState.getRound();

getSensibleMoves()

Gibt alle möglichen Züge für das aktuelle Team zurück.

Rückgabetyp: List<Move>

.getSensibleMoves()

Das ganze Konstrukt:

gameState.getSensibleMoves()

Hier ein Code-Beispiel:

List<Move> possibleMoves = gameState.getSensibleMoves();

getStartPiece()

Gibt die Start-PieceShape (Start-Spielstein) zurück.

Rückgabetyp: PieceShape

.getStartPiece()

Das ganze Konstrukt:

gameState.getStartPiece()

Hier ein Code-Beispiel:

PieceShape startPiece = gameState.getStartPiece();

getStartTeam()

Gibt das Team zurück, das das Spiel beginnt.

Rückgabetyp: Team

.getStartTeam()

Das ganze Konstrukt:

gameState.getStartTeam()

Hier ein Code-Beispiel:

Team startTeam = gameState.getStartTeam();

getTurn()

Gibt die aktuelle Runde zurück.

Rückgabetyp: int

.getTurn()

Das ganze Konstrukt:

gameState.getTurn()

Hier ein Code-Beispiel:

int currentTurn = gameState.getTurn();

getWinCondition()

Gibt die Gewinnbedingung des Spiels zurück.

Rückgabetyp: WinCondition

.getWinCondition()

Das ganze Konstrukt:

gameState.getWinCondition()

Hier ein Code-Beispiel:

WinCondition winCondition = gameState.getWinCondition();

hasValidColors()

Überprüft, ob alle Farben im Spiel gültig sind.

Rückgabetyp: boolean

.hasValidColors()

Das ganze Konstrukt:

gameState.hasValidColors()

Hier ein Code-Beispiel:

boolean valid = gameState.hasValidColors();

isOver()

Überprüft, ob das Spiel beendet ist.

Rückgabetyp: boolean

.isOver()

Das ganze Konstrukt:

gameState.isOver()

Hier ein Code-Beispiel:

boolean gameOver = gameState.isOver();

isValidColor(Color)

Überprüft, ob eine gegebene Farbe im Spiel gültig ist.

Rückgabetyp: boolean

.isValidColor(Color color)

Das ganze Konstrukt:

gameState.isValidColor(color)

Hier ein Code-Beispiel:

boolean isValid = gameState.isValidColor(redColor);

performMove(Move)

Führt einen ausgewählten Zug aus und gibt einen neuen Spielstand zurück.

Rückgabetyp: GameState

.performMove(Move move)

Das ganze Konstrukt:

gameState.performMove(move)

Hier ein Code-Beispiel:

GameState newState = gameState.performMove(selectedMove);

performMoveDirectly(Move)

Führt einen ausgewählten Zug aus und verändert dabei den aktuellen Spielstand.

Rückgabetyp: void

.performMoveDirectly(Move move)

Das ganze Konstrukt:

gameState.performMoveDirectly(move)

Hier ein Code-Beispiel:

gameState.performMoveDirectly(selectedMove);

roundFromTurn(int)

Berechnet die Runde aus einer gegebenen Zugnummer.

Rückgabetyp: int

.roundFromTurn(int turn)

Das ganze Konstrukt:

gameState.roundFromTurn(turn)

Hier ein Code-Beispiel:

int round = gameState.roundFromTurn(42);

setLastMove(Move)

Setzt den letzten Zug.

Rückgabetyp: void

.setLastMove(Move move)

Das ganze Konstrukt:

gameState.setLastMove(move)

Hier ein Code-Beispiel:

gameState.setLastMove(newMove);

setTurn(int)

Setzt die aktuelle Zugnummer.

Rückgabetyp: void

.setTurn(int turn)

Das ganze Konstrukt:

gameState.setTurn(turn)

Hier ein Code-Beispiel:

gameState.setTurn(5);

setTurnAndRound(int)

Setzt Zugnummer und Runde.

Rückgabetyp: void

.setTurnAndRound(int turn)

Das ganze Konstrukt:

gameState.setTurnAndRound(turn)

Hier ein Code-Beispiel:

gameState.setTurnAndRound(10);

teamStats()

Gibt eine Liste von Statistiken für alle Teams zurück.

Rückgabetyp: List<Stat>

.teamStats()

Das ganze Konstrukt:

gameState.teamStats()

Hier ein Code-Beispiel:

List<Stat> stats = gameState.teamStats();

undeployedPieceShapes()

Gibt eine Sammlung der noch nicht eingesetzten PieceShapes zurück.

Rückgabetyp: Collection<PieceShape>

.undeployedPieceShapes()

Das ganze Konstrukt:

gameState.undeployedPieceShapes()

Hier ein Code-Beispiel:

Collection<PieceShape> remainingPieces = gameState.undeployedPieceShapes();