code refactoring

ValentinGurkov · ValentinGurkov · commit afb70e70d534 · 2019-11-29T11:07:53.000+02:00
diff --git a/Audio/AudioRandomizer.cs b/Audio/AudioRandomizer.cs
@@ -2,8 +2,7 @@
 
 namespace RPG.Audio {
     public class AudioRandomizer : MonoBehaviour {
-        [SerializeField]
-        private AudioClip[] audioClips;
+        [SerializeField] private AudioClip[] audioClips;
 
         private AudioSource audioSource;
 
diff --git a/Audio/Footsteps.cs b/Audio/Footsteps.cs
@@ -1,6 +1,10 @@
 ﻿using UnityEngine;
 
 namespace RPG.Audio {
+    //TODO
+    /// <summary>
+    /// The implementation for footsteps sounds is still TODO
+    /// </summary>
     public class Footsteps : MonoBehaviour {
         [SerializeField] private AudioClip walkClip;
         [SerializeField] private AudioClip runClip;
diff --git a/Combat/CombatTarget.cs b/Combat/CombatTarget.cs
@@ -1,15 +1,16 @@
 ﻿using RPG.Attributes;
 using RPG.Core;
+using RPG.NPC;
 using UnityEngine;
 
 namespace RPG.Combat {
 
     [RequireComponent(typeof(Health))]
-    public class CombatTarget : MonoBehaviour, IRaycastable {
+    public class CombatTarget : NPCBase {
 
-        public CursorType Cursor => CursorType.Combat;
+        public new CursorType Cursor => CursorType.Combat;
 
-        public bool HandleRaycast(GameObject callingObject) {
+        public new bool HandleRaycast(GameObject callingObject) {
             Fighter fighter = callingObject.GetComponent<Fighter>();
             if (!fighter.CanAttack(gameObject)) {
                 return false;
diff --git a/Combat/Fighter.cs b/Combat/Fighter.cs
@@ -35,6 +35,7 @@ public class Fighter : MonoBehaviour, IAction, ISaveable, IModifierProvider {
         private CinematicControlRemover[] cinematicControlRemovers;
 
         public event Action updateTargetUI;
+        public Health Target => target;
 
         private void Awake() {
             mover = GetComponent<Mover>();
@@ -72,7 +73,7 @@ private void Update() {
                 return;
             }
 
-            if (!GetIsInRange()) {
+            if (!GetIsInRange(target.transform)) {
                 mover.MoveTo(target.transform.position, 1f);
                 stopped = false;
             } else {
@@ -99,16 +100,16 @@ private void AttackBehaviour() {
 
         private void MakeEyeContact() {
             characterBehaviour.LookAtTarget(target.transform);
-            target.GetComponent<CharacterBehaviour>().AttackedBy(gameObject);
+            target.GetComponent<CharacterBehaviour>().LookAtTarget(gameObject.transform);
         }
 
         private void TriggerAttack() {
             animator.ResetTrigger(STOP_ATTACK_TRIGGER);
             animator.SetTrigger(ATTACK_TRIGGER);
         }
 
-        private bool GetIsInRange() {
-            return IsTargetInRange(transform, target.transform, currentWeaponConfig.Range);
+        private bool GetIsInRange(Transform targetTransform) {
+            return IsTargetInRange(transform, targetTransform, currentWeaponConfig.Range);
         }
 
         // Animation Trigger
@@ -140,15 +141,13 @@ private void StopAttack() {
             animator.SetTrigger(STOP_ATTACK_TRIGGER);
         }
 
-        public Health Target => target;
-
         public void EquipWeapon(WeaponConfig weapon) {
             currentWeaponConfig = weapon;
             currentWeapon.value = weapon.Spawn(rightHandTransform, leftHandTransform, animator);
         }
 
         public bool CanAttack(GameObject target) {
-            if (target == null || !mover.CanMoveTo(target.transform.position)) {
+            if (target == null || (!mover.CanMoveTo(target.transform.position) && !GetIsInRange(target.transform))) {
                 return false;
             }
 
diff --git a/Combat/PickupBase.cs b/Combat/PickupBase.cs
@@ -1,20 +1,19 @@
 ﻿using System.Collections;
-using RPG.Attributes;
 using RPG.Core;
 using RPG.Movement;
 using UnityEngine;
 using UnityEngine.Events;
 
 namespace RPG.Combat {
     public class PickupBase : MonoBehaviour, IRaycastable {
-        [SerializeField] public OnPickupEvent onPickup;
+        private Collider objectCollider;
 
-        public CursorType Cursor => CursorType.Pickup;
+        [SerializeField] public OnPickupEvent onPickup;
 
         [System.Serializable]
         public class OnPickupEvent : UnityEvent<PickupBase> { }
 
-        private Collider objectCollider;
+        public CursorType Cursor => CursorType.Pickup;
 
         private void Awake() {
             objectCollider = GetComponent<Collider>();
@@ -33,7 +32,7 @@ private void ShowPickup(bool shouldShow) {
             }
         }
 
-        public void Pickup(bool respawnable, float respawnTime) {
+        protected void Pickup(bool respawnable, float respawnTime) {
             if (respawnable) {
                 StartCoroutine(HideForSeconds(respawnTime));
             } else {
diff --git a/Core/CharacterBehaviour.cs b/Core/CharacterBehaviour.cs
@@ -9,9 +9,5 @@ public void LookAtTarget(Transform targetTransform) {
             Quaternion targetRotation = Quaternion.LookRotation(targetTransform.position - transform.position);
             transform.rotation = Quaternion.Slerp(transform.rotation, targetRotation, rotationSpeed * Time.deltaTime);
         }
-
-        public void AttackedBy(GameObject target) {
-            LookAtTarget(target.transform);
-        }
     }
 }
diff --git a/Events/EventSystem.cs b/Events/EventSystem.cs
@@ -1,5 +1,6 @@
 ﻿using RPG.Attributes;
 using RPG.Combat;
+using RPG.Core;
 using RPG.NPC;
 using UnityEngine;
 
@@ -32,6 +33,7 @@ public void ItemPickedUp(PickupBase pickup) {
         public void InitiatedDialogue(DialogueInitiator npc) {
             if (OnTalkedToNPC != null) {
                 OnTalkedToNPC(npc);
+                GetComponent<ActionScheduler>().CancelCurrentAction();
             }
         }
     }
diff --git a/NPC/DialogueInitiator.cs b/NPC/DialogueInitiator.cs
@@ -4,13 +4,13 @@
 using UnityEngine.Events;
 
 namespace RPG.NPC {
-    public class DialogueInitiator : NPC {
+    public class DialogueInitiator : NPCBase {
         [SerializeField] private Dialogue dialogue;
         [SerializeField] private DialogueManager dialogueManager;
-        [SerializeField] public OnPickupEvent onDialogeInitiated;
+        [SerializeField] public OnDialogueInitiatedEvent onDialogeInitiated;
 
         [System.Serializable]
-        public class OnPickupEvent : UnityEvent<DialogueInitiator> { }
+        public class OnDialogueInitiatedEvent : UnityEvent<DialogueInitiator> { }
 
         public new CursorType Cursor => CursorType.Converse;
         public DialogueManager DialogueManager => dialogueManager;
diff --git a/NPC/NPCBase.cs b/NPC/NPCBase.cs
@@ -5,15 +5,17 @@
 
 namespace RPG.NPC {
     [DisallowMultipleComponent]
-    public class NPC : MonoBehaviour, IRaycastable {
+    public class NPCBase : MonoBehaviour, IRaycastable {
 
         public CursorType Cursor => CursorType.NPC;
         public virtual void Interact() { }
 
         public bool HandleRaycast(GameObject callingObject) {
             if (Input.GetMouseButtonDown(0)) {
                 if (IsTargetInRange(callingObject.transform, transform, 2.5f)) {
-                    callingObject.GetComponent<CharacterBehaviour>().LookAtTarget(transform);
+                    //TODO make this work with CharacterBehaviour's smooth LookAt. Maybe use a Coroutine?
+                    transform.LookAt(callingObject.transform);
+                    callingObject.transform.LookAt(transform);
                     Interact();
                 } else {
                     callingObject.GetComponent<Mover>().StartMovement(transform.position, 1f).InteractWithTarget(delegate { Interact(); });
diff --git a/NPC/NPCBase.cs.meta b/NPC/NPCBase.cs.meta
diff --git a/Questing/Quests/Liberator.cs b/Questing/Quests/Liberator.cs
@@ -1,5 +1,6 @@
 using RPG.Questing;
 
+//TODO Turn quests into scriptable objects
 public class Liberator : Quest {
     private void Awake() {
         QuestName = "Ultimate Slayer";
diff --git a/Stats/IModifierProvider.cs b/Stats/IModifierProvider.cs
@@ -1,9 +1,11 @@
 ﻿using System.Collections.Generic;
 
 namespace RPG.Stats {
+    /// <summary>
+    /// Classes that provide modifiers to base stats implement this interface
+    /// </summary>
     public interface IModifierProvider {
         IEnumerable<float> GetAdditiveModifiers(Stat stat);
         IEnumerable<float> GetPercentageModifiers(Stat stat);
     }
-
 }
diff --git a/UI/CameraFacing.cs b/UI/CameraFacing.cs
@@ -1,6 +1,6 @@
 ﻿using UnityEngine;
 
-namespace RPG.Control {
+namespace RPG.UI {
     public class CameraFacing : MonoBehaviour {
 
         private void LateUpdate() {
diff --git a/UI/CameraFacing.cs.meta b/UI/CameraFacing.cs.meta
diff --git a/UI/Damage Text/DamageText.cs b/UI/Damage Text/DamageText.cs
@@ -4,7 +4,7 @@
 
 namespace RPG.UI {
     public class DamageText : MonoBehaviour {
-        [SerializeField] Text damageText = null;
+        [SerializeField] private Text damageText = null;
 
         public void DestroyText() {
             Destroy(gameObject);
diff --git a/UI/Damage Text/DamageTextSpawner.cs b/UI/Damage Text/DamageTextSpawner.cs
@@ -2,7 +2,7 @@
 
 namespace RPG.UI {
     public class DamageTextSpawner : MonoBehaviour {
-        [SerializeField] DamageText damageTextPrefab = null;
+        [SerializeField] private DamageText damageTextPrefab = null;
 
         public void Spawn(float damage) {
             DamageText instance = Instantiate<DamageText>(damageTextPrefab, transform);
diff --git a/UI/ExperienceDisplay.cs b/UI/ExperienceDisplay.cs
@@ -5,6 +5,7 @@
 
 namespace RPG.UI {
     public class ExperienceDisplay : MonoBehaviour {
+
         private Experience experience;
         private TextMeshProUGUI text;
 
diff --git a/UI/Health.meta b/UI/Health.meta
diff --git a/UI/Health/EnemyHealthDisplay.cs b/UI/Health/EnemyHealthDisplay.cs
@@ -5,8 +5,8 @@
 
 namespace RPG.UI {
     public class EnemyHealthDisplay : MonoBehaviour {
-        private Fighter fighter;
 
+        private Fighter fighter;
         private TextMeshProUGUI text;
         private string defaultText;
 
diff --git a/UI/Health/EnemyHealthDisplay.cs.meta b/UI/Health/EnemyHealthDisplay.cs.meta
diff --git a/UI/Health/HealthBar.cs b/UI/Health/HealthBar.cs
diff --git a/UI/Health/HealthBar.cs.meta b/UI/Health/HealthBar.cs.meta
diff --git a/UI/Health/HealthDisplay.cs b/UI/Health/HealthDisplay.cs
@@ -5,6 +5,7 @@
 
 namespace RPG.UI {
     public class HealthDisplay : MonoBehaviour {
+
         private Health health;
         private TextMeshProUGUI text;
 
diff --git a/UI/Health/HealthDisplay.cs.meta b/UI/Health/HealthDisplay.cs.meta
diff --git a/UI/LevelToDisplay.cs b/UI/LevelToDisplay.cs
@@ -5,6 +5,7 @@
 
 namespace RPG.UI {
     public class LevelToDisplay : MonoBehaviour {
+
         private BaseStats baseStats;
         private TextMeshProUGUI text;
 
diff --git a/Util/Utility.cs b/Util/Utility.cs
@@ -3,7 +3,13 @@
 namespace RPG.Util {
 
     public static class Utility {
-
+        /// <summary>
+        /// More performant way of calculating distance than using Vector3.Distance().
+        /// </summary>
+        /// <param name="me"></param>First object of interest.
+        /// <param name="target"></param>Second object of interest.
+        /// <param name="distance"></param>Distance between objects to check.
+        /// <returns>Whether the target is in range or not.</returns>
         public static bool IsTargetInRange(Transform me, Transform target, float distance) {
             return (me.position - target.position).sqrMagnitude < distance * distance;
         }

Original file line number	Diff line number	Diff line change
`@@ -9,9 +9,5 @@ public void LookAtTarget(Transform targetTransform) {`
`9`	`9`	`Quaternion targetRotation = Quaternion.LookRotation(targetTransform.position - transform.position);`
`10`	`10`	`transform.rotation = Quaternion.Slerp(transform.rotation, targetRotation, rotationSpeed * Time.deltaTime);`
`11`	`11`	`}`
`12`		`-`
`13`		`- public void AttackedBy(GameObject target) {`
`14`		`- LookAtTarget(target.transform);`
`15`		`- }`
`16`	`12`	`}`
`17`	`13`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,6 @@`
`1`	`1`	`using RPG.Attributes;`
`2`	`2`	`using RPG.Combat;`
	`3`	`+using RPG.Core;`
`3`	`4`	`using RPG.NPC;`
`4`	`5`	`using UnityEngine;`
`5`	`6`
`@@ -32,6 +33,7 @@ public void ItemPickedUp(PickupBase pickup) {`
`32`	`33`	`public void InitiatedDialogue(DialogueInitiator npc) {`
`33`	`34`	`if (OnTalkedToNPC != null) {`
`34`	`35`	`OnTalkedToNPC(npc);`
	`36`	`+ GetComponent<ActionScheduler>().CancelCurrentAction();`
`35`	`37`	`}`
`36`	`38`	`}`
`37`	`39`	`}`