Add Comments

Assets/Scripts/Enemy AI/EnemyBehaviour.cs

@@ -66,6 +66,11 @@ private void OnEnable()
 	#endregion
 
 	#region Functions
+	/// <summary>
+	/// Searches for the nearest target.
+	/// As of now it just gets the player from the Game Manager.
+	/// </summary>
+	/// <returns></returns>
 	private IEnumerator SearchForTarget()
 	{
 		while(true)
@@ -81,6 +86,10 @@ private IEnumerator SearchForTarget()
 		}
 	}
 
+	/// <summary>
+	/// Moves the enemy to the target at a set interval.
+	/// </summary>
+	/// <returns></returns>
 	private IEnumerator MoveToTarget()
 	{
 		while(true)
@@ -98,6 +107,10 @@ private IEnumerator MoveToTarget()
 		}
 	}
 
+	/// <summary>
+	/// Attacks the target at a set interval
+	/// </summary>
+	/// <returns></returns>
 	private IEnumerator AttackTarget()
 	{
 		while(true)
@@ -115,6 +128,11 @@ private IEnumerator AttackTarget()
 		}
 	}
 
+	/// <summary>
+	/// IDamageable Damage Implementation
+	/// Decreases the health and handles what needs to happen when health falls bellow 0.
+	/// </summary>
+	/// <param name="damage"></param>
 	void IDamageable.Damage(float damage)
 	{
 		health -= damage;
@@ -127,6 +145,21 @@ void IDamageable.Damage(float damage)
 		}
 	}
 
+	/// <summary>
+	/// IDamageable Impact Movement Speed Implementation.
+	/// This slows the enemy down to a crawl.
+	/// </summary>
+	/// <param name="value"></param>
+	void IDamageable.ImpactMovementSpeed(float value)
+	{
+		moveSpeed = value;
+		agent.speed = moveSpeed;
+	}
+
+	/// <summary>
+	/// Removes all the active components once the Enemy is considered Dead.
+	/// This is done so the enemy carcass can still exist in the world without having all the code still run on the background.
+	/// </summary>
 	private void RemoveAllActiveComponents()
 	{
 		target = null;
@@ -136,12 +169,6 @@ private void RemoveAllActiveComponents()
 		Destroy(GetComponent<NavMeshAgent>());
 		Destroy(this);
 	}
-
-	void IDamageable.ImpactMovementSpeed(float value)
-	{
-		moveSpeed = value;
-		agent.speed = moveSpeed;
-	}
 	#endregion
 
 	#region Debugging

Assets/Scripts/Player/PlayerBehaviour.cs

@@ -14,7 +14,7 @@ public class PlayerBehaviour : MonoBehaviour, IDamageable
 	[SerializeField] private float manaRegenInterval = default;                             // How much time in between regen ticks.
 	[Space]
 	[SerializeField] private GameObject currentTarget = default;                            // Current Target of the player.
-	[SerializeField] private GameObject previousTarget = default;                               // Next Target of the player.
+	[SerializeField] private GameObject previousTarget = default;                           // Next Target of the player.
 	[Space]
 	[Header("Attack Spells")]
 	[SerializeField] private GameObject primaryAttackPrefab = default;                      // Primary Attack Prefab.
@@ -46,6 +46,8 @@ public class PlayerBehaviour : MonoBehaviour, IDamageable
 	public float MaxMana { get => maxMana; set => maxMana = value; }
 	#endregion
 
+
+	#region Monobehaviour Callbacks
 	private void Awake()
 	{
 		charController = GetComponent<CharacterController>();
@@ -70,7 +72,12 @@ private void Update()
 			if(currentTarget.GetComponent<EnemyBehaviour>() != null)
 				if(currentTarget.GetComponent<EnemyBehaviour>().State == EnemyState.Dead) currentTarget = null;
 	}
+	#endregion
 
+	#region Functions
+	/// <summary>
+	/// Handles the player movement.
+	/// </summary>
 	private void PlayerMovement()
 	{
 		float horInput = Input.GetAxisRaw(horizontalInputName);
@@ -88,6 +95,9 @@ private void PlayerMovement()
 		JumpInput();
 	}
 
+	/// <summary>
+	/// Sets the movementspeed
+	/// </summary>
 	private void SetMovementSpeed()
 	{
 		if(Input.GetKey(runKey))
@@ -96,6 +106,9 @@ private void SetMovementSpeed()
 			movementSpeed = Mathf.Lerp(movementSpeed, walkSpeed, Time.deltaTime * runBuildUpSpeed);
 	}
 
+	/// <summary>
+	/// Handles jump input.
+	/// </summary>
 	private void JumpInput()
 	{
 		if(Input.GetKeyDown(jumpKey) && !isJumping)
@@ -105,6 +118,9 @@ private void JumpInput()
 		}
 	}
 
+	/// <summary>
+	/// Checks for Attack Input.
+	/// </summary>
 	private void AttackInput()
 	{
 		if(currentTarget)
@@ -123,6 +139,10 @@ private void AttackInput()
 		}
 	}
 
+	/// <summary>
+	/// Attack Event.
+	/// </summary>
+	/// <param name="attackSpellToSpawns"></param>
 	private void AttackEvent(GameObject attackSpellToSpawns)
 	{
 		if(mana - attackSpellToSpawns.GetComponent<Spell>().ManaCost > 0)
@@ -157,6 +177,10 @@ private void AttackEvent(GameObject attackSpellToSpawns)
 		}
 	}
 
+	/// <summary>
+	/// Jump Event.
+	/// </summary>
+	/// <returns></returns>
 	private IEnumerator JumpEvent()
 	{
 		charController.slopeLimit = 90f;
@@ -172,6 +196,10 @@ private IEnumerator JumpEvent()
 		isJumping = false;
 	}
 
+	/// <summary>
+	/// Handles everything that should be done when walking over a slope.
+	/// </summary>
+	/// <returns></returns>
 	private bool OnSlope()
 	{
 		if(isJumping)
@@ -183,6 +211,9 @@ private bool OnSlope()
 		return false;
 	}
 
+	/// <summary>
+	/// Checks for a cell underneath the player.
+	/// </summary>
 	private void CheckForCellUnderneathPlayer()
 	{
 		if(Physics.Raycast(transform.position, Vector3.down, out RaycastHit hit, charController.height / 2f * slopeForceRayLength))
@@ -192,6 +223,9 @@ private void CheckForCellUnderneathPlayer()
 			}
 	}
 
+	/// <summary>
+	/// Gets a target from the target layermask underneath the crosshair.
+	/// </summary>
 	private void GetTargetUnderCrosshair()
 	{
 		Ray ray = new Ray(Camera.main.transform.position, Camera.main.transform.forward * 1000f);
@@ -218,16 +252,30 @@ private void GetTargetUnderCrosshair()
 			if(previousTarget.GetComponent<Outline>() != null) previousTarget.GetComponent<Outline>().enabled = false;
 	}
 
+	/// <summary>
+	/// IDamageable Damage Implementation
+	/// Removes health from the health pool.
+	/// </summary>
+	/// <param name="damage"></param>
 	void IDamageable.Damage(float damage)
 	{
 		health -= damage;
 	}
 
+	/// <summary>
+	/// Changes the movement speed.
+	/// Only used when stepping on de Poisoned Ground Spell.
+	/// </summary>
+	/// <param name="value"></param>
 	void IDamageable.ImpactMovementSpeed(float value)
 	{
 		movementSpeed = value;
 	}
 
+	/// <summary>
+	/// Actively Regenerates the players Mana.
+	/// </summary>
+	/// <returns></returns>
 	private IEnumerator ManaRegen()
 	{
 		while(true)
@@ -237,4 +285,5 @@ private IEnumerator ManaRegen()
 			if(mana > maxMana) mana = maxMana;
 		}
 	}
+	#endregion
 }

Assets/Scripts/Spells/Spell.cs

@@ -82,6 +82,11 @@ private void Update()
 	#endregion
 
 	#region Functions
+	/// <summary>
+	/// Gets all the enemies withing a certain radius.
+	/// This gets send to the targets in radius list. This list is cleared each time we check for targets.
+	/// </summary>
+	/// <returns></returns>
 	private IEnumerator GetAllEnemiesWithinSpellRadius()
 	{
 		while(timeLeftToTick > 0)
@@ -99,6 +104,10 @@ private IEnumerator GetAllEnemiesWithinSpellRadius()
 		yield return null;
 	}
 
+	/// <summary>
+	/// Damages all the enemies in the Targets in radius list.
+	/// </summary>
+	/// <returns></returns>
 	private IEnumerator DamageEnemiesWithinSpellRadius()
 	{
 		while(timeLeftToTick > 0)