Ajout de la doc pour la Couleurs, Indicateur, IRegles, Jeton, Joueur
continuous-integration/drone/push Build is passing Details

master
Camille TURPIN-ETIENNE 12 months ago
parent a91756c7e0
commit 61f4a5e918

@ -1,5 +1,8 @@
namespace CoreLibrary
{
/// <summary>
/// Représente les couleurs disponible pour les jetons.
/// </summary>
public enum Couleur
{
ROUGE,

@ -1,25 +1,80 @@
namespace CoreLibrary
{
/// <summary>
/// Interface définissant les règles du jeu.
/// </summary>
public interface IRegles
{
/// <summary>
/// Obtient le nom des règles du jeu.
/// </summary>
string Nom { get; }
/// <summary>
/// Obtient le nombre de maximum de tours.
/// </summary>
int TourMaximum { get; }
/// <summary>
/// Obtient la taille maximal du code.
/// </summary>
int TailleCodeMaximum { get; }
/// <summary>
/// Obtient le nombre de joueurs actuels.
/// </summary>
int NbJoueurs { get; }
/// <summary>
/// Obtient le nombre de maximum de joueurs.
/// </summary>
int NbJoueursMaximum { get; }
/// <summary>
/// Ajoute un joueur avec le nom spécifié.
/// </summary>
/// <param name="nom">Nom du joueur à ajouter</param>
/// <returns>Le joueur ajouté.</returns>
Joueur AjouterJoueur(string nom);
/// <summary>
/// Récupère le joueur courant.
/// </summary>
/// <returns>Le joueur courant.</returns>
Joueur JoueurCourant();
/// <summary>
/// Passe la main au joueur suivant.
/// </summary>
void PasserLaMain();
/// <summary>
/// Génère un code selon les règles du jeu.
/// </summary>
/// <returns>Le code généré.</returns>
Code GenererCode();
/// <summary>
/// Initialise le premier joueur à jouer.
/// </summary>
void CommencerLaPartie();
/// <summary>
/// Vérifie si la partie est terminée.
/// </summary>
/// <returns>True si la partie est terminée, sinon False.</returns>
bool EstTerminee();
/// <summary>
/// Récupère les joueurs gagnants.
/// </summary>
/// <returns>Enumération des joueurs gagnants.</returns>
IEnumerable<Joueur> Gagnants();
/// <summary>
/// Récupère les joueurs perdants.
/// </summary>
/// <returns>Enumération des joueurs perdants.</returns>
IEnumerable<Joueur> Perdants();
}
}

@ -1,5 +1,8 @@
namespace CoreLibrary
{
/// <summary>
/// Représente les couleurs disponibles pour les indicateurs.
/// </summary>
public enum Indicateur
{
BONNEPLACE,

@ -1,9 +1,19 @@
namespace CoreLibrary
{
/// <summary>
/// Représente un jetons de couleur.
/// </summary>
public struct Jeton
{
/// <summary>
/// Obtient la couleur du jeton.
/// </summary>
public readonly Couleur Couleur { get; private init; }
/// <summary>
/// Initialise une nouvelle instance de la structure Jeton avec la couleur spécifiée.
/// </summary>
/// <param name="couleur">La couleur du jeton.</param>
public Jeton(Couleur couleur)
{
Couleur = couleur;

@ -1,10 +1,24 @@
namespace CoreLibrary
{
/// <summary>
/// Représente un joueur.
/// </summary>
public class Joueur
{
/// <summary>
/// Obtient le nom du joueur.
/// </summary>
public string Nom { get; private init; }
/// <summary>
/// Obtient le plateau du joueur.
/// </summary>
public Plateau Plateau { get; private init; }
/// <summary>
/// Crée une nouvelle instance de joueur avec un nom et un plateau spécifié.
/// </summary>
/// <param name="nom">Le nom du joueur</param>
/// <param name="plateau">Le plateau du joueur</param>
public Joueur(string nom, Plateau plateau)
{
Nom = nom;

Loading…
Cancel
Save