Added documentation and rewording

This commit is contained in:
2024-10-09 10:04:00 +02:00
parent dea959919c
commit 04615814a9
10 changed files with 93 additions and 44 deletions

View File

@@ -0,0 +1,57 @@
package fr.iut_fbleau.raw_api_body.entity;
import java.util.Iterator;
/**
* The interface Plateau.
*/
public interface Plateau {
/**
* Return the current player
*
* @return the player
*/
Player getPlayer();
/**
* Return the game status
* - true if party is finished
* - false else
*
* @return the boolean
*/
boolean isFinished();
/**
* Return the result of a try
* - if the move is winnable : 1
* - if the move is a draw : 0
* - if its a defeat move : -1
*
* @return the result
*/
Result getResult();
/**
* Gives previous played plies
*
* @return the iterator
*/
Iterator<Ply> givePlies();
/**
* Play a ply
*
* @param ply the ply
*/
void doo(Ply ply);
/**
* Removed a ply.
*
* @param ply the ply
*/
void undo(Ply ply);
}