doc(score): add score to partialScoreWithVictoryPoints

zucchero-sintattico · Oct 10, 2023 · 947fb60 · 947fb60
1 parent dca533f
commit 947fb60
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/src/main/scala/scatan/model/game/ops/ScoreOps.scala b/src/main/scala/scatan/model/game/ops/ScoreOps.scala
@@ -38,6 +38,12 @@ object ScoreOps:
         )
       )
 
+    /** Computes the partial scores of each player, taking into account the development cards they have assigned. A
+      * victory point card is worth 1 point.
+      *
+      * @return
+      *   a Scores object containing the partial scores of each player.
+      */
     private def partialScoresWithVictoryPointCards: Scores =
       val playersWithVictoryPointCards =
         state.developmentCards.filter(_._2.exists(_.developmentType == DevelopmentType.VictoryPoint)).map(_._1)