dokumentointia parannettu

Palikat/Palikat.cs

@@ -16,7 +16,7 @@ namespace Palikat;
 /// @version 23.11.2023
 /// <summary>
 /// Tämä on 2020-luvun versio klassisesta pulmapelistä, jossa erikokoiset palikat siirretään pinosta toiseen pinoon koko järjestykseen.
-/// Haastetta tuo siirtojen laskuri ja aika. 
+/// Haastetta tuo siirtojen laskuri. 
 /// </summary>
 public class Palikat : PhysicsGame
 {
@@ -64,6 +64,9 @@ public class Palikat : PhysicsGame
     }
     
 
+    /// <summary>
+    /// Aliohjelma luo pelikentän ja tarvittavat oliot sekä laskurin kentälle
+    /// </summary>
     public void Peli()
     {
         if (peliKerrat > 0)
@@ -78,7 +81,10 @@ public class Palikat : PhysicsGame
         peliKerrat++;
     }
 
-    //Pelin kontrollit 
+    
+    /// <summary>
+    /// Luodaan pelaamisen mahdollistavat ohjaimet hiirelle
+    /// </summary>
     void Kontrollit()
     {
         PhoneBackButton.Listen(Exit, "Lopeta peli");
@@ -166,6 +172,9 @@ public class Palikat : PhysicsGame
     
     
     
+    /// <summary>
+    /// Aliohjelma jota kutsutaan kun halutaan aloittaa uusi peli ensimmäisen kerran jälkeen
+    /// </summary>
     private void AloitaAlusta()
     {
         ClearControls();
@@ -183,17 +192,16 @@ public class Palikat : PhysicsGame
     
     
     /// <summary>
-    /// TO-DO: Käynnissä olevan pelisession top3 tulokset näyttävä listaus
+    /// Parhaat pisteet näyttävä listaus
     /// </summary>
     private void ParhaatPisteet()
     {
-        //TO-DO
         topLista.Show();
     }
     
     
     /// <summary>
-    /// Aliohjelma joka luo pelikentän kutsumalla toisia aliohjelmia ja määrittää sen fysiikkaominaisuudet
+    /// Aliohjelma jolla luodaan pelikenttä 
     /// </summary>
     public void LuoKentta()
     {
@@ -218,7 +226,9 @@ public class Palikat : PhysicsGame
     }
     
     
-    //Aliohjelma jolla luodaan laskuri, joka laskee montako siirtoa pelaaja on tehnyt
+    /// <summary>
+    /// Aliohjelma joka luo laskurin, joka laskee montako siirtoa pelaaja on tehnyt
+    /// </summary>
     public void LuoPistelaskuri()
     {
         // alustetaan laskuri siten että on alussa oikeasti nolla, nyt ottaa palikoiden "asettumisen" siirtoina +4
@@ -262,6 +272,15 @@ public class Palikat : PhysicsGame
         AddCollisionHandler(palikka1, "palikka3", Palikka1OsuuPalikkaan3);
         AddCollisionHandler(palikka1, "palikka4", Palikka1OsuuPalikkaan4);
     }
+    
+    
+    /// <summary>
+    /// Aliohjelma jolla luodaan siirreltävä palikka omana olionaan, määritellään sen törmäykset ja vaikutukset siirtolaskuriin
+    /// </summary>
+    /// <param name="paikka"> paikka vektorina johon palikka luodaan</param>
+    /// <param name="leveys"> palikan leveys</param>
+    /// <param name="korkeus"> palikan korkeus</param>
+    /// <param name="vari"> palikan vari</param>
     void LuoPalikka2(Vector paikka, double leveys, double korkeus, Color vari)
     {
         palikka2 = new PhysicsObject(leveys*4.5, korkeus);
@@ -277,6 +296,15 @@ public class Palikat : PhysicsGame
         AddCollisionHandler(palikka2, "palikka3", Palikka2OsuuPalikkaan3);
         AddCollisionHandler(palikka2, "palikka4", Palikka2OsuuPalikkaan4);
     }
+    
+    
+    /// <summary>
+    /// Aliohjelma jolla luodaan siirreltävä palikka omana olionaan, määritellään sen törmäykset ja vaikutukset siirtolaskuriin
+    /// </summary>
+    /// <param name="paikka"> paikka vektorina johon palikka luodaan</param>
+    /// <param name="leveys"> palikan leveys</param>
+    /// <param name="korkeus"> palikan korkeus</param>
+    /// <param name="vari"> palikan vari</param>
     void LuoPalikka3(Vector paikka, double leveys, double korkeus, Color vari)
     {
         palikka3 = new PhysicsObject(leveys*3, korkeus);
@@ -292,6 +320,14 @@ public class Palikat : PhysicsGame
         AddCollisionHandler(palikka3, "palikka4", Palikka3OsuuPalikkaan4);
     }
     
+    
+    /// <summary>
+    /// Aliohjelma jolla luodaan siirreltävä palikka omana olionaan, määritellään sen törmäykset ja vaikutukset siirtolaskuriin
+    /// </summary>
+    /// <param name="paikka"> paikka vektorina johon palikka luodaan</param>
+    /// <param name="leveys"> palikan leveys</param>
+    /// <param name="korkeus"> palikan korkeus</param>
+    /// <param name="vari"> palikan vari</param>
     void LuoPalikka4(Vector paikka, double leveys, double korkeus, Color vari)
     {
         palikka4 = new PhysicsObject(leveys*1.5, korkeus);
@@ -306,9 +342,14 @@ public class Palikat : PhysicsGame
         AddCollisionHandler(palikka4, "alusta", PalikkaOsuuAlustaan);
     }
     
+    
     /// <summary>
-    /// Luodaan alustat
+    /// Aliohjelma joka luo alusta jonka päälle palikoita pelissä järjestelläään
     /// </summary>
+    /// <param name="paikka"> paikka vektorina johon palikka luodaan</param>
+    /// <param name="leveys"> palikan leveys</param>
+    /// <param name="korkeus"> palikan korkeus</param>
+    /// <param name="vari"> palikan vari</param>
     void LuoAlusta(Vector paikka, double leveys, double korkeus, Color vari)
     {
         PhysicsObject alusta = new PhysicsObject(leveys*8, korkeus);
@@ -320,7 +361,9 @@ public class Palikat : PhysicsGame
     }
     
     
-    ///Määritellään säännöt/rajoiteet pelin siirroille ja siirtojen laskenta siirtolaskuriin
+    /// <summary>
+    /// Aliohjelma jollla määritellään mita tapahtuu kun palikka osuu alustaa
+    /// </summary>
     void PalikkaOsuuAlustaan(PhysicsObject palikka, PhysicsObject alusta)
     {
         //laskurin arvo kasvaa yhdellä
@@ -336,7 +379,9 @@ public class Palikat : PhysicsGame
         }
     }
 
-
+    /// <summary>
+    /// Aliohjelma jollla määritellään mita tapahtuu kun palikka osuu toiseen palikkaan
+    /// </summary>
     void Palikka1OsuuPalikkaan2(PhysicsObject p1, PhysicsObject p2)
     {
         //laskurin arvo kasvaa yhdellä
@@ -350,12 +395,15 @@ public class Palikat : PhysicsGame
             neljasoikein = false;
             Console.WriteLine("Toka palikka oikein!");
         }
-        if (palikka2.Position.Y < palikka1.Position.Y && palikka2.Position.X)
+        //if (palikka2.Position.Y < palikka1.Position.Y && palikka2.Position.X)
             
         
     }
     
     
+    /// <summary>
+    /// Aliohjelma jollla määritellään mita tapahtuu kun palikka osuu toiseen palikkaan
+    /// </summary>
     void Palikka1OsuuPalikkaan3(PhysicsObject p1, PhysicsObject p2)
     {
         //laskurin arvo kasvaa yhdellä
@@ -364,6 +412,9 @@ public class Palikat : PhysicsGame
     }
 
     
+    /// <summary>
+    /// Aliohjelma jollla määritellään mita tapahtuu kun palikka osuu toiseen palikkaan
+    /// </summary>
     void Palikka1OsuuPalikkaan4(PhysicsObject p1, PhysicsObject p2)
     {
         //laskurin arvo kasvaa yhdellä
@@ -371,6 +422,10 @@ public class Palikat : PhysicsGame
         Console.WriteLine("Palikka1 osui palikkaan4"); //osuma näkyy konsolissa - poistetaan valmiista
     }
     
+    
+    /// <summary>
+    /// Aliohjelma jollla määritellään mita tapahtuu kun palikka osuu toiseen palikkaan
+    /// </summary>
     void Palikka2OsuuPalikkaan3(PhysicsObject p1, PhysicsObject p2)
     {
         //laskurin arvo kasvaa yhdellä
@@ -386,6 +441,10 @@ public class Palikat : PhysicsGame
         
     }
     
+    
+    /// <summary>
+    /// Aliohjelma jollla määritellään mita tapahtuu kun palikka osuu toiseen palikkaan
+    /// </summary>
     void Palikka2OsuuPalikkaan4(PhysicsObject p1, PhysicsObject p2)
     {
         //laskurin arvo kasvaa yhdellä
@@ -393,6 +452,10 @@ public class Palikat : PhysicsGame
         Console.WriteLine("Palikka2 osui palikkaan4"); //osuma näkyy konsolissa - poistetaan valmiista
     }
     
+    
+    /// <summary>
+    /// Aliohjelma jollla määritellään mita tapahtuu kun palikka osuu toiseen palikkaan
+    /// </summary>
     void Palikka3OsuuPalikkaan4(PhysicsObject p1, PhysicsObject p2)
     {
         //laskurin arvo kasvaa yhdellä
@@ -407,6 +470,9 @@ public class Palikat : PhysicsGame
     }
     
     
+    /// <summary>
+    /// Aliohjelma jota kutsutaan kun peli on pelattu läpi ja jolla kirjataan highscore
+    /// </summary>
     void Voitto()
     {
         topLista.EnterAndShow(pistelaskuri.Value);