Update from TeamSTEP/Catch.io@c2de675

TeamSTEP · Nov 14, 2024 · 81d0df5 · 81d0df5
1 parent 4a8385f
commit 81d0df5
Show file tree

Hide file tree

Showing 5 changed files with 470 additions and 459 deletions.
diff --git a/api/CatchIo.Runtime.NPC.Core.NPCPathFinder.html b/api/CatchIo.Runtime.NPC.Core.NPCPathFinder.html
@@ -83,7 +83,8 @@
 
   <h1 id="CatchIo_Runtime_NPC_Core_NPCPathFinder" data-uid="CatchIo.Runtime.NPC.Core.NPCPathFinder" class="text-break">Class NPCPathFinder
   </h1>
-  <div class="markdown level0 summary"></div>
+  <div class="markdown level0 summary"><p>NPCPathFinder handles the movement pathfinding for NPCs, including random wandering within specified movement radii and interaction with the Photon network for synchronization.</p>
+</div>
   <div class="markdown level0 conceptual"></div>
   <div class="inheritance">
     <h5>Inheritance</h5>
@@ -106,7 +107,8 @@ <h3 id="methods">Methods
 
   <a id="CatchIo_Runtime_NPC_Core_NPCPathFinder_GetSpeed_" data-uid="CatchIo.Runtime.NPC.Core.NPCPathFinder.GetSpeed*"></a>
   <h4 id="CatchIo_Runtime_NPC_Core_NPCPathFinder_GetSpeed" data-uid="CatchIo.Runtime.NPC.Core.NPCPathFinder.GetSpeed">GetSpeed()</h4>
-  <div class="markdown level1 summary"></div>
+  <div class="markdown level1 summary"><p>Gets the NPC&apos;s current speed.</p>
+</div>
   <div class="markdown level1 conceptual"></div>
   <h5 class="decalaration">Declaration</h5>
   <div class="codewrapper">
@@ -123,15 +125,17 @@ <h5 class="returns">Returns</h5>
     <tbody>
       <tr>
         <td><span class="xref">System.Single</span></td>
-        <td></td>
+        <td><p>A float representing the current speed.</p>
+</td>
       </tr>
     </tbody>
   </table>
 
 
   <a id="CatchIo_Runtime_NPC_Core_NPCPathFinder_GetVelocity_" data-uid="CatchIo.Runtime.NPC.Core.NPCPathFinder.GetVelocity*"></a>
   <h4 id="CatchIo_Runtime_NPC_Core_NPCPathFinder_GetVelocity" data-uid="CatchIo.Runtime.NPC.Core.NPCPathFinder.GetVelocity">GetVelocity()</h4>
-  <div class="markdown level1 summary"></div>
+  <div class="markdown level1 summary"><p>Gets the NPC&apos;s current velocity.</p>
+</div>
   <div class="markdown level1 conceptual"></div>
   <h5 class="decalaration">Declaration</h5>
   <div class="codewrapper">
@@ -148,15 +152,17 @@ <h5 class="returns">Returns</h5>
     <tbody>
       <tr>
         <td><span class="xref">Vector2</span></td>
-        <td></td>
+        <td><p>A Vector2 representing the current velocity.</p>
+</td>
       </tr>
     </tbody>
   </table>
 
 
   <a id="CatchIo_Runtime_NPC_Core_NPCPathFinder_IsMoving_" data-uid="CatchIo.Runtime.NPC.Core.NPCPathFinder.IsMoving*"></a>
   <h4 id="CatchIo_Runtime_NPC_Core_NPCPathFinder_IsMoving" data-uid="CatchIo.Runtime.NPC.Core.NPCPathFinder.IsMoving">IsMoving()</h4>
-  <div class="markdown level1 summary"></div>
+  <div class="markdown level1 summary"><p>Checks if the NPC is currently moving.</p>
+</div>
   <div class="markdown level1 conceptual"></div>
   <h5 class="decalaration">Declaration</h5>
   <div class="codewrapper">
@@ -173,15 +179,17 @@ <h5 class="returns">Returns</h5>
     <tbody>
       <tr>
         <td><span class="xref">System.Boolean</span></td>
-        <td></td>
+        <td><p>True if the NPC has a non-zero velocity, otherwise false.</p>
+</td>
       </tr>
     </tbody>
   </table>
 
 
   <a id="CatchIo_Runtime_NPC_Core_NPCPathFinder_OnPhotonSerializeView_" data-uid="CatchIo.Runtime.NPC.Core.NPCPathFinder.OnPhotonSerializeView*"></a>
   <h4 id="CatchIo_Runtime_NPC_Core_NPCPathFinder_OnPhotonSerializeView_PhotonStream_PhotonMessageInfo_" data-uid="CatchIo.Runtime.NPC.Core.NPCPathFinder.OnPhotonSerializeView(PhotonStream,PhotonMessageInfo)">OnPhotonSerializeView(PhotonStream, PhotonMessageInfo)</h4>
-  <div class="markdown level1 summary"></div>
+  <div class="markdown level1 summary"><p>Synchronizes the NPC&apos;s velocity across the network using Photon.</p>
+</div>
   <div class="markdown level1 conceptual"></div>
   <h5 class="decalaration">Declaration</h5>
   <div class="codewrapper">
@@ -200,12 +208,14 @@ <h5 class="parameters">Parameters</h5>
       <tr>
         <td><span class="xref">PhotonStream</span></td>
         <td><span class="parametername">stream</span></td>
-        <td></td>
+        <td><p>The PhotonStream used for data serialization.</p>
+</td>
       </tr>
       <tr>
         <td><span class="xref">PhotonMessageInfo</span></td>
         <td><span class="parametername">info</span></td>
-        <td></td>
+        <td><p>Information about the Photon message.</p>
+</td>
       </tr>
     </tbody>
   </table>

diff --git a/api/CatchIo.Runtime.NPC.Core.html b/api/CatchIo.Runtime.NPC.Core.html
@@ -90,7 +90,8 @@ <h3 id="classes">Classes
       <h4><a class="xref" href="CatchIo.Runtime.NPC.Core.NPCHealth.html">NPCHealth</a></h4>
       <section></section>
       <h4><a class="xref" href="CatchIo.Runtime.NPC.Core.NPCPathFinder.html">NPCPathFinder</a></h4>
-      <section></section>
+      <section><p>NPCPathFinder handles the movement pathfinding for NPCs, including random wandering within specified movement radii and interaction with the Photon network for synchronization.</p>
+</section>
 </article>
           </div>
 

diff --git a/index.json b/index.json
@@ -1422,7 +1422,7 @@
   "api/CatchIo.Runtime.NPC.Core.html": {
     "href": "api/CatchIo.Runtime.NPC.Core.html",
     "title": "Namespace CatchIo.Runtime.NPC.Core | Catch.io Developer Reference",
-    "keywords": "Namespace CatchIo.Runtime.NPC.Core Classes NPCHealth NPCPathFinder"
+    "keywords": "Namespace CatchIo.Runtime.NPC.Core Classes NPCHealth NPCPathFinder NPCPathFinder handles the movement pathfinding for NPCs, including random wandering within specified movement radii and interaction with the Photon network for synchronization."
   },
   "api/CatchIo.Runtime.NPC.Core.NPCHealth.html": {
     "href": "api/CatchIo.Runtime.NPC.Core.NPCHealth.html",
@@ -1432,7 +1432,7 @@
   "api/CatchIo.Runtime.NPC.Core.NPCPathFinder.html": {
     "href": "api/CatchIo.Runtime.NPC.Core.NPCPathFinder.html",
     "title": "Class NPCPathFinder | Catch.io Developer Reference",
-    "keywords": "Class NPCPathFinder Inheritance System.Object NPCPathFinder Implements IPunObservable Namespace : CatchIo.Runtime.NPC.Core Assembly : cs.temp.dll.dll Syntax public class NPCPathFinder : MonoBehaviour Methods GetSpeed() Declaration public float GetSpeed() Returns Type Description System.Single GetVelocity() Declaration public Vector2 GetVelocity() Returns Type Description Vector2 IsMoving() Declaration public bool IsMoving() Returns Type Description System.Boolean OnPhotonSerializeView(PhotonStream, PhotonMessageInfo) Declaration public void OnPhotonSerializeView(PhotonStream stream, PhotonMessageInfo info) Parameters Type Name Description PhotonStream stream PhotonMessageInfo info Implements IPunObservable"
+    "keywords": "Class NPCPathFinder NPCPathFinder handles the movement pathfinding for NPCs, including random wandering within specified movement radii and interaction with the Photon network for synchronization. Inheritance System.Object NPCPathFinder Implements IPunObservable Namespace : CatchIo.Runtime.NPC.Core Assembly : cs.temp.dll.dll Syntax public class NPCPathFinder : MonoBehaviour Methods GetSpeed() Gets the NPC's current speed. Declaration public float GetSpeed() Returns Type Description System.Single A float representing the current speed. GetVelocity() Gets the NPC's current velocity. Declaration public Vector2 GetVelocity() Returns Type Description Vector2 A Vector2 representing the current velocity. IsMoving() Checks if the NPC is currently moving. Declaration public bool IsMoving() Returns Type Description System.Boolean True if the NPC has a non-zero velocity, otherwise false. OnPhotonSerializeView(PhotonStream, PhotonMessageInfo) Synchronizes the NPC's velocity across the network using Photon. Declaration public void OnPhotonSerializeView(PhotonStream stream, PhotonMessageInfo info) Parameters Type Name Description PhotonStream stream The PhotonStream used for data serialization. PhotonMessageInfo info Information about the Photon message. Implements IPunObservable"
   },
   "api/CatchIo.Runtime.NPC.Data.html": {
     "href": "api/CatchIo.Runtime.NPC.Data.html",

diff --git a/manifest.json b/manifest.json
@@ -3376,7 +3376,7 @@
       "output": {
         ".html": {
           "relative_path": "api/CatchIo.Runtime.NPC.Core.NPCPathFinder.html",
-          "hash": "NhTuRBu0EjV8Q1aqslkbyuekS+7kF3feKUtWgi+qGhE="
+          "hash": "TE/j8Wkl5vQ+8S1NczWe34n5WdeLlGhZV9QNrcJrJVo="
         }
       },
       "is_incremental": false,
@@ -3388,7 +3388,7 @@
       "output": {
         ".html": {
           "relative_path": "api/CatchIo.Runtime.NPC.Core.html",
-          "hash": "3MWdu4telud6wHra/kyKbgkcr2gO28gx8RHe0yFgp74="
+          "hash": "3P+E5JKRDwhTRPqIg2Ayb5uUD/gfM3ZVfPK/obRi56o="
         }
       },
       "is_incremental": false,