de.fhkiel.ki.cathedral.ai.Agent Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of cathedral-game Show documentation

A cathedral implementation in Java

The newest version!

package de.fhkiel.ki.cathedral.ai;

import de.fhkiel.ki.cathedral.game.Game;
import de.fhkiel.ki.cathedral.game.Placement;
import java.io.PrintStream;
import java.util.Optional;
import javax.swing.JComponent;

/**
 * An interface for AI agents to play cathedral on {@link de.fhkiel.ki.cathedral.gui.CathedralGUI}
 *
 * @author Eike Petersen {@literal }
 * @version 1.0
 * @since 1.0
 */
public interface Agent {

  /**
   * Funktion to name the agent. Will be used when adding the agent to the GUI.
   *
   * @return the name
   */
  default String name(){
    return getClass().getName();
  }

  /**
   * Initializes the agent. Gets the basic game and an Printstream to a GUI-console.
   *
   * @param game    a cathedral game
   * @param console stream to the console
   */
  default void initialize(Game game, PrintStream console){}

  /**
   * To insert a agent-specific gui element.
   *
   * @return the gui elemt in an optional
   */
  default Optional guiElement(){return Optional.empty();}

  /**
   * Funktion to calculate the agents next action.
   *
   * @param game        the game
   * @param timeForTurn the time for turn
   * @param timeBonus   the time bonus
   * @return the possible Placement in an optional, if optional is empty turn will be forfeit
   */
  Optional calculateTurn(Game game, int timeForTurn, int timeBonus);

  /**
   * Call to evaluate the last turn.
   *
   * @param game the game
   * @return the evaluation
   */
  default String evaluateLastTurn(Game game){ return "No evaluation done"; }

  /**
   * Called on game end.
   *
   * @param game the game
   */
  default void gameFinished(Game game){}

  /**
   * Stops the agent. Any calculations, etc should be canceled
   */
  default void stop(){}

}