Partitions et messages

Comme nous l'avons vu, un total de quatre partitions de zones existent dans ChaCuN : celle des forêts, celle des prés, celle des rivières et celle des zones aquatiques — rivières et lacs. Ces partitions évoluent au cours de la partie, au fur et à mesure que des tuiles sont déposées sur le plateau, connectant certaines aires entre elles.

Comme cela a été brièvement expliqué dans l'introduction au projet, lors d'une partie de ChaCuN, des messages sont affichés sur la droite de l'interface, sur ce que nous nommerons le tableau d'affichage (message board). Le but de ces messages est d'informer les joueurs du déroulement de la partie, généralement pour leur dire qui a gagné des points, et pourquoi.

La partie graphique du tableau d'affichage sera mise en œuvre dans une étape ultérieure, mais la classe permettant de générer et de stocker les messages le sera dans celle-ci. Les sections suivantes énumèrent donc les différentes situations dans lesquelles un message doit être généré.

L'enregistrement ZonePartitions (avec un s à la fin !) du paquetage principal, public et immuable, regroupe les quatre partitions de zones du jeu. Il possède donc les attributs suivants :

• ZonePartition<Zone.Forest> forests, la partition des forêts,
• ZonePartition<Zone.Meadow> meadows, la partition des prés,
• ZonePartition<Zone.River> rivers, la partition des rivières,
• ZonePartition<Zone.Water> riverSystems, la partition des zones aquatiques (rivières et lacs).

En dehors des méthodes ajoutées automatiquement par Java, ZonePartitions ne possède rien d'autre que l'attribut public, final et statique suivant :

• ZonePartitions EMPTY, qui représente un groupe de 4 partitions vides.

La classe Builder, publique, finale et imbriquée statiquement dans ZonePartitions, sert de bâtisseur à la classe ZonePartitions. Logiquement, ses attributs (privés) sont quatre bâtisseurs de partitions de zones, de type ZonePartition.Builder<…>.

Builder offre un unique constructeur public :

• Builder(ZonePartitions initial), qui retourne un nouveau bâtisseur dont les quatre partitions sont initialement identiques à celles du groupe de quatre partitions donné.

En plus de ce constructeur, Builder offre les méthodes publiques ci-dessous. Avant de commencer à les programmer, il est fortement recommandé de lire les conseils de programmation plus bas.

• void addTile(Tile tile), qui ajoute aux quatre partitions les aires correspondant aux zones de la tuile donnée,
• void connectSides(TileSide s1, TileSide s2), qui connecte les deux bords de tuiles donnés, en connectant entre elles les aires correspondantes, ou lève IllegalArgumentException si les deux bords ne sont pas de la même sorte,
• void addInitialOccupant(PlayerColor player, Occupant.Kind occupantKind, Zone occupiedZone), qui ajoute un occupant initial, de la sorte donnée et appartenant au joueur donné, à l'aire contenant la zone donnée, ou lève IllegalArgumentException si la sorte d'occupant donnée ne peut pas occuper une zone de la sorte donnée,
• void removePawn(PlayerColor player, Zone occupiedZone), qui supprime un occupant — un pion — appartenant au joueur donné de l'aire contenant la zone donnée, ou lève IllegalArgumentException si la zone est un lac,
• void clearGatherers(Area<Zone.Forest> forest), qui supprime tous les occupants — des pions jouant le rôle de cueilleurs — de la forêt donnée,
• void clearFishers(Area<Zone.River> river), qui supprime tous les occupants — des pions jouant le rôle de pêcheurs — de la rivière donnée,
• ZonePartitions build(), qui retourne le groupe de quatre partitions en cours de construction.

Notez que removePawn est destinée à être utilisée pour mettre en œuvre le pouvoir spécial du chaman, qui permet au joueur qui le pose de récupérer, s'il le désire, l'un de ses pions. C'est la raison pour laquelle removePawn ne peut que supprimer un pion, et pas une hutte, contrairement à addInitialOccupant qui permet d'ajouter aussi bien un pion qu'une hutte.

Pour faciliter votre travail, nous mettons à votre disposition l'interface TextMaker, publique, qui appartient au paquetage principal et est destinée à être implémentée par des classes capables de générer tout le texte qui apparaît dans l'interface graphique de ChaCuN — principalement le texte des messages, mais aussi celui donnant le nombre de points de chaque joueur, leur nom, etc.

Cette interface vous est fournie dans une archive Zip qu'il vous faut télécharger avant d'en extraire le contenu. Cela fait, le plus simple pour la placer dans votre projet consiste à trouver le fichier TextMaker.java qu'elle contient puis de le glisser dans la zone Project de votre projet IntelliJ, dans le paquetage ch.epfl.chacun.

Après avoir importé cette interface, lisez les commentaires attachés à ses méthodes, dont vous aurez besoin pour créer les messages du tableau d'affichage, comme expliqué à la §3.5 plus bas.

Notez que certaines méthodes de TextMaker prennent en argument une table associative de type Map<…>. Si vous êtes en avance dans le projet, il est possible que ce type de collection n'ait pas encore été vu au cours. Dans ce cas, nous vous conseillons d'ignorer les méthodes en question dans un premier temps, et d'y revenir une fois la matière examinée au cours.

L'enregistrement Message, imbriqué dans l'enregistrement MessageBoard décrit à la section suivante, public et immuable, représente un message affiché sur le tableau d'affichage. Il possède les attributs suivants :

• String text, le texte du message,
• int points, les points associés au message — qui peuvent valoir 0, par exemple si le message ne signale pas un gain de points,
• Set<PlayerColor> scorers, l'ensemble des joueurs ayant remportés les points, qui peut être vide si le message ne signale pas un gain de points,
• Set<Integer> tileIds, les identifiants des tuiles concernées par le message, ou un ensemble vide si le message ne concerne pas un ensemble de tuiles.

Les trois derniers attributs n'ont généralement de sens que pour les messages qui décrivent un gain de points, mais cela constitue la grande majorité d'entre eux. Par « tuiles concernées par le message », on entend généralement les tuiles qui ont permis au(x) joueur(s) de gagner les points.

En dehors de ces attributs et des méthodes ajoutées automatiquement par Java aux enregistrements, Message ne possède qu'un constructeur compact qui vérifie que le texte passé n'est pas null, que les points ne sont pas inférieurs à 0, et copie les deux ensembles pour garantir l'immuabilité.

L'enregistrement MessageBoard du paquetage principal, public et immuable, représente le contenu du tableau d'affichage. Il possède les attributs suivants :

• TextMaker textMaker, l'objet permettant d'obtenir le texte des différents messages,
• List<Message> messages, la liste des messages affichés sur le tableau, du plus ancien au plus récent.

Le constructeur compact de MessageBoard garantit l'immuabilité de la classe. En dehors de ce constructeur, MessageBoard offre les méthodes publiques suivantes :

• Map<PlayerColor, Integer> points(), qui retourne une table associant à tous les joueurs figurant dans les gagnants (scorers) d'au moins un message, le nombre total de points obtenus,
• MessageBoard withScoredForest(Area<Zone.Forest> forest), qui retourne un tableau d'affichage identique au récepteur, sauf si la forêt donnée est occupée, auquel cas le tableau contient un nouveau message signalant que ses occupants majoritaires ont remporté les points associés à sa fermeture,
• MessageBoard withClosedForestWithMenhir(PlayerColor player, Area<Zone.Forest> forest), qui retourne un tableau d'affichage identique au récepteur, mais avec un nouveau message signalant que le joueur donné a le droit de jouer un second tour après avoir fermé la forêt donnée, car elle contient un ou plusieurs menhirs,
• MessageBoard withScoredRiver(Area<Zone.River> river), qui retourne un tableau d'affichage identique au récepteur, sauf si la rivière donnée est occupée, auquel cas le tableau contient un nouveau message signalant que ses occupants majoritaires ont remporté les points associés à sa fermeture,
• MessageBoard withScoredHuntingTrap(PlayerColor scorer, Area<Zone.Meadow> adjacentMeadow), qui retourne un tableau d'affichage identique au récepteur, sauf si la pose de la fosse à pieux a permis au joueur donné, qui l'a posée, de remporter des points, auquel cas le tableau contient un nouveau message signalant cela — le pré donné comportant les mêmes occupants que le pré contenant la fosse, mais uniquement les zones se trouvant à sa portée,
• MessageBoard withScoredLogboat(PlayerColor scorer, Area<Zone.Water> riverSystem), qui retourne un tableau d'affichage identique au récepteur, mais avec un nouveau message signalant que le joueur donné a obtenu les points correspondants à la pose de la pirogue dans le réseau hydrographique donné,
• MessageBoard withScoredMeadow(Area<Zone.Meadow> meadow, Set<Animal> cancelledAnimals), qui retourne un tableau d'affichage identique au récepteur, sauf si le pré donné est occupé et que les points qu'il rapporte à ses occupants majoritaires — calculés en faisant comme si les animaux annulés donnés n'existaient pas — sont supérieurs à 0, auquel cas le tableau contient un nouveau message signalant que ces joueurs-là ont remporté les points en question,
• MessageBoard withScoredRiverSystem(Area<Zone.Water> riverSystem), qui retourne un tableau d'affichage identique au récepteur, sauf si le réseau hydrographique donné est occupé et que les points qu'il rapporte à ses occupants majoritaires sont supérieurs à 0, auquel cas le tableau contient un nouveau message signalant que ces joueurs-là ont remporté les points en question,
• MessageBoard withScoredPitTrap(Area<Zone.Meadow> adjacentMeadow, Set<Animal> cancelledAnimals), qui retourne un tableau d'affichage identique au récepteur, sauf si le pré donné, qui contient la grande fosse à pieux, est occupé et que les points — calculés en faisant comme si les animaux annulés donnés n'existaient pas — qu'il rapporte à ses occupants majoritaires sont supérieurs à 0, auquel cas le tableau contient un nouveau message signalant que ces joueurs-là ont remporté les points en question ; comme pour la « petite » fosse à pieux, le pré donné comporte les mêmes occupants que le pré contenant la fosse, mais uniquement les zones se trouvant à sa portée,
• MessageBoard withScoredRaft(Area<Zone.Water> riverSystem), qui retourne un tableau d'affichage identique au récepteur, sauf si le réseau hydrographique donné, qui contient le radeau, est occupé, auquel cas le tableau contient un nouveau message signalant que ses occupants majoritaires ont remporté les points correspondants,
• MessageBoard withWinners(Set<PlayerColor> winners, int points), qui retourne un tableau d'affichage identique au récepteur, mais avec un nouveau message signalant que le(s) joueur(s) donné(s) a/ont remporté la partie avec le nombre de points donnés.

Comme pour l'étape précédente, nous ne vous fournissons plus de tests mais un fichier de vérification de signatures à importer dans votre projet.

Notez que, si nous vous avons fourni l'interface TextMaker, nous ne vous avons fourni aucune mise en œuvre de cette interface. Pour pouvoir tester la classe MessageBoard, il vous faudra donc, dans vos tests, créer une classe implémentant cette interface. Nous vous conseillons de rendre cette classe aussi simple que possible, et en particulier de ne pas essayer de générer des messages grammaticalement corrects à ce stade, car vous ferez cela dans une étape ultérieure. Une classe dont toutes les méthodes retournent une simple concaténation de la représentation textuelle des arguments suffit largement aux tests. Par exemple, la méthode playersScoredForest ci-dessous fait l'affaire :

String playersScoredForest(Set<PlayerColor> scorers,
                           int points,
                           int mushroomGroupCount,
                           int tileCount) {
  return new StringJoiner(" ")
    .add(scorers.toString())
    .add(String.valueOf(points))
    .add(String.valueOf(mushroomGroupCount))
    .add(String.valueOf(tileCount))
    .toString();
}

(La classe StringJoiner est un bâtisseur de chaînes similaire à StringBuilder, mais qui sépare les différentes chaînes qu'on lui ajoute au moyen du séparateur fourni à son constructeur.)