Update ver 1.0

Author: KimYC1223

.vs/UnityPathGenerator/v16/.suo

@@ -9,7 +9,7 @@
     <ProductVersion>10.0.20506</ProductVersion>
     <SchemaVersion>2.0</SchemaVersion>
     <RootNamespace></RootNamespace>
-    <ProjectGuid>{3FE15C33-C38F-BFFA-DC82-D98C3E23D3F2}</ProjectGuid>
+    <ProjectGuid>{09434EEF-816A-E7B0-91C2-3ABE8AD3BEF0}</ProjectGuid>
     <OutputType>Library</OutputType>
     <AppDesignerFolder>Properties</AppDesignerFolder>
     <AssemblyName>Assembly-CSharp</AssemblyName>
@@ -595,31 +595,31 @@
       <HintPath>C:/Program Files/Unity/Hub/Editor/2019.4.2f1/Editor/Data/NetStandard/compat/2.0.0/shims/netfx/System.Xml.Serialization.dll</HintPath>
     </Reference>
     <Reference Include="Unity.Timeline.Editor">
-      <HintPath>C:/Users/movie/Desktop/AutoPathGenerator/Library/ScriptAssemblies/Unity.Timeline.Editor.dll</HintPath>
+      <HintPath>C:/src/UnityPathGenerator/Library/ScriptAssemblies/Unity.Timeline.Editor.dll</HintPath>
     </Reference>
     <Reference Include="Unity.VSCode.Editor">
-      <HintPath>C:/Users/movie/Desktop/AutoPathGenerator/Library/ScriptAssemblies/Unity.VSCode.Editor.dll</HintPath>
+      <HintPath>C:/src/UnityPathGenerator/Library/ScriptAssemblies/Unity.VSCode.Editor.dll</HintPath>
     </Reference>
     <Reference Include="Unity.TextMeshPro.Editor">
-      <HintPath>C:/Users/movie/Desktop/AutoPathGenerator/Library/ScriptAssemblies/Unity.TextMeshPro.Editor.dll</HintPath>
+      <HintPath>C:/src/UnityPathGenerator/Library/ScriptAssemblies/Unity.TextMeshPro.Editor.dll</HintPath>
     </Reference>
     <Reference Include="UnityEngine.UI">
-      <HintPath>C:/Users/movie/Desktop/AutoPathGenerator/Library/ScriptAssemblies/UnityEngine.UI.dll</HintPath>
+      <HintPath>C:/src/UnityPathGenerator/Library/ScriptAssemblies/UnityEngine.UI.dll</HintPath>
     </Reference>
     <Reference Include="Unity.Timeline">
-      <HintPath>C:/Users/movie/Desktop/AutoPathGenerator/Library/ScriptAssemblies/Unity.Timeline.dll</HintPath>
+      <HintPath>C:/src/UnityPathGenerator/Library/ScriptAssemblies/Unity.Timeline.dll</HintPath>
     </Reference>
     <Reference Include="Unity.CollabProxy.Editor">
-      <HintPath>C:/Users/movie/Desktop/AutoPathGenerator/Library/ScriptAssemblies/Unity.CollabProxy.Editor.dll</HintPath>
+      <HintPath>C:/src/UnityPathGenerator/Library/ScriptAssemblies/Unity.CollabProxy.Editor.dll</HintPath>
     </Reference>
     <Reference Include="Unity.Rider.Editor">
-      <HintPath>C:/Users/movie/Desktop/AutoPathGenerator/Library/ScriptAssemblies/Unity.Rider.Editor.dll</HintPath>
+      <HintPath>C:/src/UnityPathGenerator/Library/ScriptAssemblies/Unity.Rider.Editor.dll</HintPath>
     </Reference>
     <Reference Include="Unity.TextMeshPro">
-      <HintPath>C:/Users/movie/Desktop/AutoPathGenerator/Library/ScriptAssemblies/Unity.TextMeshPro.dll</HintPath>
+      <HintPath>C:/src/UnityPathGenerator/Library/ScriptAssemblies/Unity.TextMeshPro.dll</HintPath>
     </Reference>
     <Reference Include="UnityEditor.UI">
-      <HintPath>C:/Users/movie/Desktop/AutoPathGenerator/Library/ScriptAssemblies/UnityEditor.UI.dll</HintPath>
+      <HintPath>C:/src/UnityPathGenerator/Library/ScriptAssemblies/UnityEditor.UI.dll</HintPath>
     </Reference>
   </ItemGroup>
   <ItemGroup></ItemGroup>

Assembly-CSharp.csproj

@@ -737,10 +737,24 @@ MonoBehaviour:
   m_Script: {fileID: 11500000, guid: 539089cfe4dd8c149854dff36789b0b4, type: 3}
   m_Name: 
   m_EditorClassIdentifier: 
+  endEvent:
+    m_PersistentCalls:
+      m_Calls:
+      - m_Target: {fileID: 1506752710}
+        m_MethodName: SetActive
+        m_Mode: 6
+        m_Arguments:
+          m_ObjectArgument: {fileID: 0}
+          m_ObjectArgumentAssemblyTypeName: UnityEngine.Object, UnityEngine
+          m_IntArgument: 0
+          m_FloatArgument: 0
+          m_StringArgument: 
+          m_BoolArgument: 0
+        m_CallState: 2
   path: {fileID: 195522643}
   speed: 300
   turningSpeed: 10
-  isLoop: 1
+  isLoop: 0
   isMove: 1
 --- !u!54 &1506752712
 Rigidbody:

Assets/Scenes/SampleScene.unity

@@ -3,98 +3,167 @@
 using System.Collections.Generic;
 using UnityEngine;
 
-[RequireComponent(typeof(Rigidbody))]
+//===================================================================================================
+//
+//  PATH FOLLWER CLASS
+//
+//  Script to follow the path created by "Path Generator" class
+//  Path Generator가 만든 Path를 따라가는 기능
+//
+//---------------------------------------------------------------------------------------------------
+//  2020.08.30 _ KimYC1223
+//===================================================================================================
 
-[System.Serializable]
-public class EndEvent : UnityEngine.Events.UnityEvent<GameObject> { }
+[RequireComponent(typeof(Rigidbody))]
 
 public class PathFollower : MonoBehaviour
 {
-    public EventArgs endEvent;
-    public PathGenerator path;
-    public float speed = 100f;
-    public float turningSpeed = 10f;
-    public bool isLoop = false;
-    public bool isMove = true;
+    [System.Serializable]
+    public class EndEvent : UnityEngine.Events.UnityEvent { }
+
+    [SerializeField]
+    public EndEvent endEvent;                   // method to run when this is done moving
 
-    private Rigidbody TargetRigidbody;
-    private GameObject Target;
-    private GameObject NextAngle;
-    private int AngleStep = 1;
+    public PathGenerator path;                  // choose the path to move     
+    public float speed = 100f;                  // move speed
+    public float turningSpeed = 10f;            // rotation speed 
+    public bool isLoop = false;                 // does it move repeatedly?
+    public bool isMove = true;                  // is this moving now?
 
-    
+    private Rigidbody targetRigidbody;          // the rigidbody of the object to move
+    private GameObject target;                  // object to move;
+    private GameObject nextPath;                // the direction the obejct will move
+    private int pathIndex = 1;                  // the path index the object will move
+    private float distanceThreshold = 0.2f;     // distance threshold
 
+    //===============================================================================================
+    // Start method
+    //-----------------------------------------------------------------------------------------------
+    // init variable & position
+    // 각종 변수와 position 초기화
+    //===============================================================================================
     void Start()
     {
-        TargetRigidbody = GetComponent<Rigidbody>();
-        if (path == null) {
-            Debug.LogError("경로가 없음");
-        }
-        Target = this.gameObject;
-        NextAngle = path.PathList[1];
+        targetRigidbody = GetComponent<Rigidbody>();
+        if (path == null) 
+            Debug.LogError("no path\n경로가 없음");
+        target = this.gameObject;
+        nextPath = path.PathList[1];
         this.transform.position = path.PathList[0].transform.position;
-        if (NextAngle == null)
-            Debug.Log("gg");
     }
-    
-    // Update is called once per frame
+
+    //===============================================================================================
+    // Fixed update method
+    //-----------------------------------------------------------------------------------------------
+    // set velocity & direction, and calculate distance
+    // 속도와 방향 설정 후 거리 계산
+    //===============================================================================================
     void FixedUpdate()
     {
+        //===========================================================================================
+        //  If it is not moving, stop object and return
+        //  움직이지 않는다면, 물체를 멈추고 종료
+        //===========================================================================================
         if (!isMove) {
-            TargetRigidbody.velocity = new Vector3(0, 0, 0);
+            targetRigidbody.velocity = new Vector3(0, 0, 0);        // Stop
             return;
         }
-        // =====================================================================
-        //  자동차가 가이드를 바라보게하는 기능
-        // =====================================================================
-        Vector3 offset = NextAngle.transform.position - Target.transform.position;
+
+        //===========================================================================================
+        // Function to make objects look at the next path
+        // 물체가 다음 Path를 바라보게하는 기능
+        //===========================================================================================
+        Vector3 offset = nextPath.transform.position - target.transform.position;
         offset.Normalize();
         Quaternion q = Quaternion.LookRotation(offset);
-        TargetRigidbody.rotation =
-            Quaternion.Slerp(TargetRigidbody.rotation,
+        targetRigidbody.rotation =
+            Quaternion.Slerp(targetRigidbody.rotation,
                                         q, turningSpeed * Time.deltaTime);
 
-
-        // =====================================================================
-        //  자동차가 가이드를 따라가게 하는 기능
-        // =====================================================================
+        //===========================================================================================
+        // Function to make objects follow a path
+        // 물체가 path를 따라가게 하는 기능
+        //===========================================================================================
         offset.Normalize();
-        TargetRigidbody.velocity = offset * speed * Time.deltaTime;
+        targetRigidbody.velocity = offset * speed * Time.deltaTime;
+
+        // calculate distance between object and next path
+        // 물체와 next path 경로 사이의 거리 계산
+        float Distance = Vector3.Distance(nextPath.transform.position,
+                                          target.transform.position);
 
-        // 두 거리 계산
-        float Distance = Vector3.Distance(NextAngle.transform.position,
-                                          Target.transform.position);
+        //===========================================================================================
+        // If it is close enough to the next path
+        // next path에 충분히 가까워졌을 경우
+        //===========================================================================================
+        if (Distance < distanceThreshold) {
 
-        // =====================================================================
-        //  가이드에 가까워 졌을 경우
-        // =====================================================================
-        if (Distance < 0.2f) {
-            
-            if(AngleStep >= path.PathList.Count) {
+            if (pathIndex < path.PathList.Count) {
+            //=======================================================================================
+            // If the end of the path list is not reached, set the next path by increase path Index
+            // path 리스트의 끝에 도달하지 못했다면, path Index ++ 를 통해 next path 설정
+            //=======================================================================================
+                nextPath = path.PathList[pathIndex++];
+            } else {
+                //===================================================================================
+                // If the object reached end of the path list,
+                // path 리스트 끝에 도달했다면, 즉, 최종 목적지에 도달했을때
+                //===================================================================================
                 if (path.isClosed) {
-                    NextAngle = path.PathList[0];
-                    AngleStep = 0;
+                    //===============================================================================
+                    // If current path is closed path, back to zero of the path list
+                    // 현재 path가 닫힌 경로이면, 다시 pathList[0]을 향해 전진
+                    //===============================================================================
+                    nextPath = path.PathList[0];
+                    pathIndex = 0;
                 } else {
-                    if(isLoop) {
-                        NextAngle = path.PathList[1];
-                        AngleStep = 1;
+                    //===============================================================================
+                    // If current path is open path,
+                    // 현재 path가 열린 경로이면,
+                    //===============================================================================
+                    if (isLoop) {
+                        //===========================================================================
+                        // and object move repeatedly reinit position & value;
+                        // 그리고 물체가 반복적으로 움직인다면, position과 변수 다시 초기화
+                        //===========================================================================
+                        nextPath = path.PathList[1];
+                        pathIndex = 1;
                         this.transform.position = path.PathList[0].transform.position;
-                        Target.transform.LookAt(path.PathList[1].transform);
+                        target.transform.LookAt(path.PathList[1].transform);
+                        // If endEvent isn't null, run method.
+                        // endEvent가 null이 아니면, method를 실행
+                        if (endEvent != null)
+                            endEvent.Invoke();
                     } else {
+                        //==========================================================================
+                        // If object move once, Stop move and if endEvent isn't null, run method.
+                        // 물체가 한번만 움직이면 멈추고, endEvent!=null이 아니면, method를 실행
+                        //==========================================================================
                         StopFollow();
+                        if (endEvent != null)
+                            endEvent.Invoke();
                     }
                 }
-            } else {
-                NextAngle = path.PathList[AngleStep++];
             } 
         }
     }
 
-
+    //===============================================================================================
+    // Stop Follow method
+    //-----------------------------------------------------------------------------------------------
+    // stop move by set isMove false
+    // 정지
+    //===============================================================================================
     public void StopFollow() {
         isMove = false;
     }
 
+    //===============================================================================================
+    // Start Follow method
+    //-----------------------------------------------------------------------------------------------
+    // Start move by set isMove true
+    // 움직임
+    //===============================================================================================
     public void StartFollow() {
         isMove = true;
     }

Assets/Scripts/PathFollower.cs

@@ -3,24 +3,44 @@
 using UnityEngine;
 using UnityEngine.UI;
 
+//===================================================================================================
+//
+//  PATH PATH GENERATOR CLASS
+//
+//  Script to make followable path the based on Bézier Curve
+//  Path Generator가 만든 Path를 따라가는 기능
+//
+//---------------------------------------------------------------------------------------------------
+//  2020.08.30 _ KimYC1223
+//===================================================================================================
+
 public class PathGenerator : MonoBehaviour {
-    public GameObject Flag;
-    public GameObject StartFlag;
-    public GameObject Angle;
-    public GameObject Guide;
-    public bool isClosed = true;
-    public bool isDebugObject = false;
-    public bool isDebugLine = false;
-    public int PathDensity = 30;
+    public GameObject Flag;                 // Visual maker of stopover
+    public GameObject StartFlag;            // Visual maker of start point
+    public GameObject Angle;                // Visual maker of angle setter
+    public GameObject Guide;                // Visual maker of path guide
+    public bool isClosed = true;            // is this path closed?
+    public bool isDebugObject = false;      // show Flag and Angle objects in play mode?
+    public bool isDebugLine = false;        // show guide objects in play mode?
+    public int PathDensity = 30;            // Density of guide objects between Flags
 
-    public List<GameObject> FlagList = new List<GameObject>();
-    public List<GameObject> AngleList = new List<GameObject>();
-    internal List<GameObject> PathList = new List<GameObject>();
-
-    private Transform Roads;
+    public List<GameObject> FlagList = new List<GameObject>();    // List of Flag objects
+    public List<GameObject> AngleList = new List<GameObject>();   // List of Angle objects
+    internal List<GameObject> PathList = new List<GameObject>();  // List of Path objects
+    private Transform Roads;                                      // Root object of guide objects
 
+    //===============================================================================================
+    // Awake method
+    //-----------------------------------------------------------------------------------------------
+    // init variable & position
+    // 각종 변수와 position 초기화
+    //===============================================================================================
     public void Awake() {
-        if(PathDensity < 2) {
+        //===========================================================================================
+        //  check path density is bigger than 1
+        //  path density가 1보다 큰 지 확인
+        //===========================================================================================
+        if (PathDensity < 2) {
 #if UNITY_EDITOR
             Debug.LogError("Path Density is too small. (must >= 2)");
             UnityEditor.EditorApplication.isPlaying = false;
@@ -31,6 +51,10 @@ public void Awake() {
 #endif
         }
 
+        //===========================================================================================
+        //  Get root object of guides for Instantiate guide object
+        //  guide 오브젝트를 Instantiate 하기 위한 부모 객체 가져오기
+        //===========================================================================================
         Transform[] childs = this.transform.GetComponentsInChildren<Transform>();
         foreach(Transform t in childs) {
             if (t.gameObject.name == "Roads")