From 5eab7595376225f7323fd651f2e23c6e8e6f49e5 Mon Sep 17 00:00:00 2001
From: Domonkos Nagy <nagydomonkos1@gmail.com>
Date: Thu, 25 May 2023 08:55:21 +0200
Subject: [PATCH] Clean Code done

---
 .../Assets/Scripts/Logic/Managers/GameManager.cs  |  6 +++---
 .../Scripts/Logic/MapAndMovement/MapManager.cs    | 15 +++++++++++----
 .../Scripts/Logic/RobotAction/RobotAction.cs      |  3 +++
 .../Assets/Scripts/Logic/Tasks/TaskValidator.cs   |  6 ++++++
 4 files changed, 23 insertions(+), 7 deletions(-)

diff --git a/ChaoticCrates/Assets/Scripts/Logic/Managers/GameManager.cs b/ChaoticCrates/Assets/Scripts/Logic/Managers/GameManager.cs
index aef538a..ef75161 100644
--- a/ChaoticCrates/Assets/Scripts/Logic/Managers/GameManager.cs
+++ b/ChaoticCrates/Assets/Scripts/Logic/Managers/GameManager.cs
@@ -177,7 +177,9 @@ namespace Logic.Managers
         }
 
         #endregion
-
+    
+        #region Public methods
+        
         public override void OnNetworkSpawn()
         {
             if(!IsHost) return;
@@ -199,8 +201,6 @@ namespace Logic.Managers
             base.OnNetworkSpawn();
         }
 
-    
-        #region Public methods
         /// <summary>
         /// Update GameState and fire an event
         /// </summary>
diff --git a/ChaoticCrates/Assets/Scripts/Logic/MapAndMovement/MapManager.cs b/ChaoticCrates/Assets/Scripts/Logic/MapAndMovement/MapManager.cs
index f92a88b..d95f047 100644
--- a/ChaoticCrates/Assets/Scripts/Logic/MapAndMovement/MapManager.cs
+++ b/ChaoticCrates/Assets/Scripts/Logic/MapAndMovement/MapManager.cs
@@ -304,6 +304,12 @@ namespace Logic.MapAndMovement
             }
         }
 
+        /// <summary>
+        /// Open a gate on the edge of the map
+        /// </summary>
+        /// <param name="side">Side number</param>
+        /// <param name="pos">Gate start position</param>
+        /// <param name="gateSize">Gate size</param>
         private void OpenGate(int side, int pos, int gateSize)
         {
             int x = 0, y = 0;
@@ -348,6 +354,10 @@ namespace Logic.MapAndMovement
             }
         }
 
+        /// <summary>
+        /// Initialize tilemap edges
+        /// </summary>
+        /// <returns></returns>
         private IEnumerator InitTileMap()
         {
             Tilemap tilemap = tileMap.GetComponent<Tilemap>();
@@ -408,10 +418,7 @@ namespace Logic.MapAndMovement
             Tilemap tilemap = tileMap.GetComponent<Tilemap>();
             tilemap.SetTile(new Vector3Int(x, y), tile == 0 ? exitTile : forbiddenTile);
         }
-        #endregion
-
-        #region Public methods
-
+        
         private IEnumerator HideSprite(Dictionary<ulong, KeyValuePair<string, string>> dict)
         {
             List<ulong> normalIds = new List<ulong>();
diff --git a/ChaoticCrates/Assets/Scripts/Logic/RobotAction/RobotAction.cs b/ChaoticCrates/Assets/Scripts/Logic/RobotAction/RobotAction.cs
index d4310c5..325fa4e 100644
--- a/ChaoticCrates/Assets/Scripts/Logic/RobotAction/RobotAction.cs
+++ b/ChaoticCrates/Assets/Scripts/Logic/RobotAction/RobotAction.cs
@@ -4,6 +4,9 @@ using System;
 
 namespace Logic.RobotAction
 {
+    /// <summary>
+    /// Abstract Robot Action class to inherit from
+    /// </summary>
     public abstract class RobotAction
     {
         public abstract void DoAction();
diff --git a/ChaoticCrates/Assets/Scripts/Logic/Tasks/TaskValidator.cs b/ChaoticCrates/Assets/Scripts/Logic/Tasks/TaskValidator.cs
index 3a50c16..d268d45 100644
--- a/ChaoticCrates/Assets/Scripts/Logic/Tasks/TaskValidator.cs
+++ b/ChaoticCrates/Assets/Scripts/Logic/Tasks/TaskValidator.cs
@@ -5,6 +5,9 @@ using UnityEngine;
 
 namespace Logic.Tasks
 {
+    /// <summary>
+    /// Class for validating a pattern
+    /// </summary>
     public class TaskValidator
     {
         private readonly GameObject _playerObject;
@@ -14,6 +17,9 @@ namespace Logic.Tasks
             _playerObject = playerObject;
         }
 
+        /// <summary>
+        /// Try to validate the pattern, if valid add points to the team and generate new task
+        /// </summary>
         public void TryValidate()
         {
             Vector3Int playerPos = Vector3Int.RoundToInt(_playerObject.transform.position);
-- 
GitLab