Update from TeamSTEP/Catch.io@403820d

TeamSTEP · Nov 20, 2024 · 6654526 · 6654526
1 parent a827dda
commit 6654526
Show file tree

Hide file tree

Showing 31 changed files with 2,812 additions and 1,271 deletions.
diff --git a/api/CatchIo.Runtime.Character.Core.CharacterMovement.html b/api/CatchIo.Runtime.Character.Core.CharacterMovement.html
@@ -100,6 +100,31 @@ <h3 id="methods">Methods
   </h3>
 
 
+  <a id="CatchIo_Runtime_Character_Core_CharacterMovement_GetVelocity_" data-uid="CatchIo.Runtime.Character.Core.CharacterMovement.GetVelocity*"></a>
+  <h4 id="CatchIo_Runtime_Character_Core_CharacterMovement_GetVelocity" data-uid="CatchIo.Runtime.Character.Core.CharacterMovement.GetVelocity">GetVelocity()</h4>
+  <div class="markdown level1 summary"></div>
+  <div class="markdown level1 conceptual"></div>
+  <h5 class="decalaration">Declaration</h5>
+  <div class="codewrapper">
+    <pre><code class="lang-csharp hljs">public Vector2 GetVelocity()</code></pre>
+  </div>
+  <h5 class="returns">Returns</h5>
+  <table class="table table-bordered table-striped table-condensed">
+    <thead>
+      <tr>
+        <th>Type</th>
+        <th>Description</th>
+      </tr>
+    </thead>
+    <tbody>
+      <tr>
+        <td><span class="xref">Vector2</span></td>
+        <td></td>
+      </tr>
+    </tbody>
+  </table>
+
+
   <a id="CatchIo_Runtime_Character_Core_CharacterMovement_Lock_" data-uid="CatchIo.Runtime.Character.Core.CharacterMovement.Lock*"></a>
   <h4 id="CatchIo_Runtime_Character_Core_CharacterMovement_Lock" data-uid="CatchIo.Runtime.Character.Core.CharacterMovement.Lock">Lock()</h4>
   <div class="markdown level1 summary"></div>

diff --git a/api/CatchIo.Runtime.Character.Graphics.CharacterAnimator.html b/api/CatchIo.Runtime.Character.Graphics.CharacterAnimator.html
@@ -96,18 +96,19 @@ <h5 id="CatchIo_Runtime_Character_Graphics_CharacterAnimator_syntax">Syntax</h5>
   <div class="codewrapper">
     <pre><code class="lang-csharp hljs">public class CharacterAnimator : MonoBehaviour</code></pre>
   </div>
-  <h3 id="fields">Fields
+  <h3 id="properties">Properties
   </h3>
 
 
-  <h4 id="CatchIo_Runtime_Character_Graphics_CharacterAnimator_OnActionAnimCompleted" data-uid="CatchIo.Runtime.Character.Graphics.CharacterAnimator.OnActionAnimCompleted">OnActionAnimCompleted</h4>
+  <a id="CatchIo_Runtime_Character_Graphics_CharacterAnimator_RuntimeAnimatorController_" data-uid="CatchIo.Runtime.Character.Graphics.CharacterAnimator.RuntimeAnimatorController*"></a>
+  <h4 id="CatchIo_Runtime_Character_Graphics_CharacterAnimator_RuntimeAnimatorController" data-uid="CatchIo.Runtime.Character.Graphics.CharacterAnimator.RuntimeAnimatorController">RuntimeAnimatorController</h4>
   <div class="markdown level1 summary"></div>
   <div class="markdown level1 conceptual"></div>
   <h5 class="decalaration">Declaration</h5>
   <div class="codewrapper">
-    <pre><code class="lang-csharp hljs">public Action OnActionAnimCompleted</code></pre>
+    <pre><code class="lang-csharp hljs">public RuntimeAnimatorController RuntimeAnimatorController { get; set; }</code></pre>
   </div>
-  <h5 class="fieldValue">Field Value</h5>
+  <h5 class="propertyValue">Property Value</h5>
   <table class="table table-bordered table-striped table-condensed">
     <thead>
       <tr>
@@ -117,68 +118,91 @@ <h5 class="fieldValue">Field Value</h5>
     </thead>
     <tbody>
       <tr>
-        <td><span class="xref">System.Action</span></td>
+        <td><span class="xref">RuntimeAnimatorController</span></td>
         <td></td>
       </tr>
     </tbody>
   </table>
-  <h3 id="properties">Properties
+  <h3 id="methods">Methods
   </h3>
 
 
-  <a id="CatchIo_Runtime_Character_Graphics_CharacterAnimator_RuntimeAnimatorController_" data-uid="CatchIo.Runtime.Character.Graphics.CharacterAnimator.RuntimeAnimatorController*"></a>
-  <h4 id="CatchIo_Runtime_Character_Graphics_CharacterAnimator_RuntimeAnimatorController" data-uid="CatchIo.Runtime.Character.Graphics.CharacterAnimator.RuntimeAnimatorController">RuntimeAnimatorController</h4>
+  <a id="CatchIo_Runtime_Character_Graphics_CharacterAnimator_HasActionAnimation_" data-uid="CatchIo.Runtime.Character.Graphics.CharacterAnimator.HasActionAnimation*"></a>
+  <h4 id="CatchIo_Runtime_Character_Graphics_CharacterAnimator_HasActionAnimation_CharacterActionType_" data-uid="CatchIo.Runtime.Character.Graphics.CharacterAnimator.HasActionAnimation(CharacterActionType)">HasActionAnimation(CharacterActionType)</h4>
   <div class="markdown level1 summary"></div>
   <div class="markdown level1 conceptual"></div>
   <h5 class="decalaration">Declaration</h5>
   <div class="codewrapper">
-    <pre><code class="lang-csharp hljs">public RuntimeAnimatorController RuntimeAnimatorController { get; set; }</code></pre>
+    <pre><code class="lang-csharp hljs">public bool HasActionAnimation(CharacterActionType type)</code></pre>
   </div>
-  <h5 class="propertyValue">Property Value</h5>
+  <h5 class="parameters">Parameters</h5>
   <table class="table table-bordered table-striped table-condensed">
     <thead>
       <tr>
         <th>Type</th>
+        <th>Name</th>
         <th>Description</th>
       </tr>
     </thead>
     <tbody>
       <tr>
-        <td><span class="xref">RuntimeAnimatorController</span></td>
+        <td><span class="xref">CharacterActionType</span></td>
+        <td><span class="parametername">type</span></td>
         <td></td>
       </tr>
     </tbody>
   </table>
-  <h3 id="methods">Methods
+  <h5 class="returns">Returns</h5>
+  <table class="table table-bordered table-striped table-condensed">
+    <thead>
+      <tr>
+        <th>Type</th>
+        <th>Description</th>
+      </tr>
+    </thead>
+    <tbody>
+      <tr>
+        <td><span class="xref">System.Boolean</span></td>
+        <td></td>
+      </tr>
+    </tbody>
+  </table>
+  <h3 id="events">Events
   </h3>
 
 
-  <a id="CatchIo_Runtime_Character_Graphics_CharacterAnimator_HasActionAnimation_" data-uid="CatchIo.Runtime.Character.Graphics.CharacterAnimator.HasActionAnimation*"></a>
-  <h4 id="CatchIo_Runtime_Character_Graphics_CharacterAnimator_HasActionAnimation_CharacterActionType_" data-uid="CatchIo.Runtime.Character.Graphics.CharacterAnimator.HasActionAnimation(CharacterActionType)">HasActionAnimation(CharacterActionType)</h4>
+  <h4 id="CatchIo_Runtime_Character_Graphics_CharacterAnimator_OnActionAnimationCompleted" data-uid="CatchIo.Runtime.Character.Graphics.CharacterAnimator.OnActionAnimationCompleted">OnActionAnimationCompleted</h4>
   <div class="markdown level1 summary"></div>
   <div class="markdown level1 conceptual"></div>
   <h5 class="decalaration">Declaration</h5>
   <div class="codewrapper">
-    <pre><code class="lang-csharp hljs">public bool HasActionAnimation(CharacterActionType type)</code></pre>
+    <pre><code class="lang-csharp hljs">public event Action OnActionAnimationCompleted</code></pre>
   </div>
-  <h5 class="parameters">Parameters</h5>
+  <h5 class="eventType">Event Type</h5>
   <table class="table table-bordered table-striped table-condensed">
     <thead>
       <tr>
         <th>Type</th>
-        <th>Name</th>
         <th>Description</th>
       </tr>
     </thead>
     <tbody>
       <tr>
-        <td><span class="xref">CharacterActionType</span></td>
-        <td><span class="parametername">type</span></td>
+        <td><span class="xref">System.Action</span></td>
         <td></td>
       </tr>
     </tbody>
   </table>
-  <h5 class="returns">Returns</h5>
+
+
+  <h4 id="CatchIo_Runtime_Character_Graphics_CharacterAnimator_OnAnimatorLoaded" data-uid="CatchIo.Runtime.Character.Graphics.CharacterAnimator.OnAnimatorLoaded">OnAnimatorLoaded</h4>
+  <div class="markdown level1 summary"></div>
+  <div class="markdown level1 conceptual"></div>
+  <h5 class="decalaration">Declaration</h5>
+  <div class="codewrapper">
+    <pre><code class="lang-csharp hljs">public event Action&lt;RuntimeAnimatorController&gt; OnAnimatorLoaded</code></pre>
+  </div>
+  <h5 class="eventType">Event Type</h5>
   <table class="table table-bordered table-striped table-condensed">
     <thead>
       <tr>
@@ -188,7 +212,7 @@ <h5 class="returns">Returns</h5>
     </thead>
     <tbody>
       <tr>
-        <td><span class="xref">System.Boolean</span></td>
+        <td><span class="xref">System.Action</span>&lt;<span class="xref">RuntimeAnimatorController</span>&gt;</td>
         <td></td>
       </tr>
     </tbody>

diff --git a/api/CatchIo.Runtime.Character.Graphics.CharacterRenderer.html b/api/CatchIo.Runtime.Character.Graphics.CharacterRenderer.html
@@ -100,6 +100,31 @@ <h3 id="properties">Properties
   </h3>
 
 
+  <a id="CatchIo_Runtime_Character_Graphics_CharacterRenderer_CharacterAnimator_" data-uid="CatchIo.Runtime.Character.Graphics.CharacterRenderer.CharacterAnimator*"></a>
+  <h4 id="CatchIo_Runtime_Character_Graphics_CharacterRenderer_CharacterAnimator" data-uid="CatchIo.Runtime.Character.Graphics.CharacterRenderer.CharacterAnimator">CharacterAnimator</h4>
+  <div class="markdown level1 summary"></div>
+  <div class="markdown level1 conceptual"></div>
+  <h5 class="decalaration">Declaration</h5>
+  <div class="codewrapper">
+    <pre><code class="lang-csharp hljs">public CharacterAnimator CharacterAnimator { get; }</code></pre>
+  </div>
+  <h5 class="propertyValue">Property Value</h5>
+  <table class="table table-bordered table-striped table-condensed">
+    <thead>
+      <tr>
+        <th>Type</th>
+        <th>Description</th>
+      </tr>
+    </thead>
+    <tbody>
+      <tr>
+        <td><a class="xref" href="CatchIo.Runtime.Character.Graphics.CharacterAnimator.html">CharacterAnimator</a></td>
+        <td></td>
+      </tr>
+    </tbody>
+  </table>
+
+
   <a id="CatchIo_Runtime_Character_Graphics_CharacterRenderer_SpriteRenderer_" data-uid="CatchIo.Runtime.Character.Graphics.CharacterRenderer.SpriteRenderer*"></a>
   <h4 id="CatchIo_Runtime_Character_Graphics_CharacterRenderer_SpriteRenderer" data-uid="CatchIo.Runtime.Character.Graphics.CharacterRenderer.SpriteRenderer">SpriteRenderer</h4>
   <div class="markdown level1 summary"></div>
@@ -210,6 +235,38 @@ <h5 class="returns">Returns</h5>
       </tr>
     </tbody>
   </table>
+
+
+  <a id="CatchIo_Runtime_Character_Graphics_CharacterRenderer_SetFloat_" data-uid="CatchIo.Runtime.Character.Graphics.CharacterRenderer.SetFloat*"></a>
+  <h4 id="CatchIo_Runtime_Character_Graphics_CharacterRenderer_SetFloat_System_Int32_System_Single_" data-uid="CatchIo.Runtime.Character.Graphics.CharacterRenderer.SetFloat(System.Int32,System.Single)">SetFloat(Int32, Single)</h4>
+  <div class="markdown level1 summary"></div>
+  <div class="markdown level1 conceptual"></div>
+  <h5 class="decalaration">Declaration</h5>
+  <div class="codewrapper">
+    <pre><code class="lang-csharp hljs">public void SetFloat(int propertyId, float value)</code></pre>
+  </div>
+  <h5 class="parameters">Parameters</h5>
+  <table class="table table-bordered table-striped table-condensed">
+    <thead>
+      <tr>
+        <th>Type</th>
+        <th>Name</th>
+        <th>Description</th>
+      </tr>
+    </thead>
+    <tbody>
+      <tr>
+        <td><span class="xref">System.Int32</span></td>
+        <td><span class="parametername">propertyId</span></td>
+        <td></td>
+      </tr>
+      <tr>
+        <td><span class="xref">System.Single</span></td>
+        <td><span class="parametername">value</span></td>
+        <td></td>
+      </tr>
+    </tbody>
+  </table>
 </article>
           </div>
 

diff --git a/api/CatchIo.Runtime.Character.Receivers.CharacterBodyDamageReceiver.html b/api/CatchIo.Runtime.Character.Receivers.CharacterBodyDamageReceiver.html
@@ -98,9 +98,13 @@ <h5>Implements</h5>
     <div><span class="xref">IKnockBackable</span></div>
     <div><span class="xref">IStunnable</span></div>
     <div><span class="xref">ICharacterInteractable</span></div>
+    <div><span class="xref">ITransmorphableReceiver</span></div>
   </div>
   <div class="inheritedMembers">
     <h5>Inherited Members</h5>
+    <div>
+      <a class="xref" href="CatchIo.Runtime.Character.Receivers.CharacterDamageReceiver.html#CatchIo_Runtime_Character_Receivers_CharacterDamageReceiver__character">CharacterDamageReceiver._character</a>
+    </div>
     <div>
       <a class="xref" href="CatchIo.Runtime.Character.Receivers.CharacterDamageReceiver.html#CatchIo_Runtime_Character_Receivers_CharacterDamageReceiver_IsAlive">CharacterDamageReceiver.IsAlive</a>
     </div>
@@ -129,10 +133,62 @@ <h5 id="CatchIo_Runtime_Character_Receivers_CharacterBodyDamageReceiver_syntax">
   <div class="codewrapper">
     <pre><code class="lang-csharp hljs">public sealed class CharacterBodyDamageReceiver : CharacterDamageReceiver</code></pre>
   </div>
+  <h3 id="properties">Properties
+  </h3>
+
+
+  <a id="CatchIo_Runtime_Character_Receivers_CharacterBodyDamageReceiver_ViewID_" data-uid="CatchIo.Runtime.Character.Receivers.CharacterBodyDamageReceiver.ViewID*"></a>
+  <h4 id="CatchIo_Runtime_Character_Receivers_CharacterBodyDamageReceiver_ViewID" data-uid="CatchIo.Runtime.Character.Receivers.CharacterBodyDamageReceiver.ViewID">ViewID</h4>
+  <div class="markdown level1 summary"></div>
+  <div class="markdown level1 conceptual"></div>
+  <h5 class="decalaration">Declaration</h5>
+  <div class="codewrapper">
+    <pre><code class="lang-csharp hljs">public int ViewID { get; }</code></pre>
+  </div>
+  <h5 class="propertyValue">Property Value</h5>
+  <table class="table table-bordered table-striped table-condensed">
+    <thead>
+      <tr>
+        <th>Type</th>
+        <th>Description</th>
+      </tr>
+    </thead>
+    <tbody>
+      <tr>
+        <td><span class="xref">System.Int32</span></td>
+        <td></td>
+      </tr>
+    </tbody>
+  </table>
   <h3 id="methods">Methods
   </h3>
 
 
+  <a id="CatchIo_Runtime_Character_Receivers_CharacterBodyDamageReceiver_GetAnimatorController_" data-uid="CatchIo.Runtime.Character.Receivers.CharacterBodyDamageReceiver.GetAnimatorController*"></a>
+  <h4 id="CatchIo_Runtime_Character_Receivers_CharacterBodyDamageReceiver_GetAnimatorController" data-uid="CatchIo.Runtime.Character.Receivers.CharacterBodyDamageReceiver.GetAnimatorController">GetAnimatorController()</h4>
+  <div class="markdown level1 summary"></div>
+  <div class="markdown level1 conceptual"></div>
+  <h5 class="decalaration">Declaration</h5>
+  <div class="codewrapper">
+    <pre><code class="lang-csharp hljs">public RuntimeAnimatorController GetAnimatorController()</code></pre>
+  </div>
+  <h5 class="returns">Returns</h5>
+  <table class="table table-bordered table-striped table-condensed">
+    <thead>
+      <tr>
+        <th>Type</th>
+        <th>Description</th>
+      </tr>
+    </thead>
+    <tbody>
+      <tr>
+        <td><span class="xref">RuntimeAnimatorController</span></td>
+        <td></td>
+      </tr>
+    </tbody>
+  </table>
+
+
   <a id="CatchIo_Runtime_Character_Receivers_CharacterBodyDamageReceiver_GetIndicatorPosition_" data-uid="CatchIo.Runtime.Character.Receivers.CharacterBodyDamageReceiver.GetIndicatorPosition*"></a>
   <h4 id="CatchIo_Runtime_Character_Receivers_CharacterBodyDamageReceiver_GetIndicatorPosition" data-uid="CatchIo.Runtime.Character.Receivers.CharacterBodyDamageReceiver.GetIndicatorPosition">GetIndicatorPosition()</h4>
   <div class="markdown level1 summary"></div>
@@ -245,6 +301,9 @@ <h3 id="implements">Implements</h3>
   <div>
       <span class="xref">ICharacterInteractable</span>
   </div>
+  <div>
+      <span class="xref">ITransmorphableReceiver</span>
+  </div>
 </article>
           </div>
 

diff --git a/api/CatchIo.Runtime.Character.Receivers.CharacterDamageReceiver.html b/api/CatchIo.Runtime.Character.Receivers.CharacterDamageReceiver.html
@@ -105,6 +105,33 @@ <h5 id="CatchIo_Runtime_Character_Receivers_CharacterDamageReceiver_syntax">Synt
   <div class="codewrapper">
     <pre><code class="lang-csharp hljs">public abstract class CharacterDamageReceiver : DamageReceiver</code></pre>
   </div>
+  <h3 id="fields">Fields
+  </h3>
+
+
+  <h4 id="CatchIo_Runtime_Character_Receivers_CharacterDamageReceiver__character" data-uid="CatchIo.Runtime.Character.Receivers.CharacterDamageReceiver._character">_character</h4>
+  <div class="markdown level1 summary"><p>Reference to the CharacterFacade that manages the character&apos;s status and behavior.</p>
+</div>
+  <div class="markdown level1 conceptual"></div>
+  <h5 class="decalaration">Declaration</h5>
+  <div class="codewrapper">
+    <pre><code class="lang-csharp hljs">protected CharacterFacade _character</code></pre>
+  </div>
+  <h5 class="fieldValue">Field Value</h5>
+  <table class="table table-bordered table-striped table-condensed">
+    <thead>
+      <tr>
+        <th>Type</th>
+        <th>Description</th>
+      </tr>
+    </thead>
+    <tbody>
+      <tr>
+        <td><a class="xref" href="CatchIo.Runtime.Character.CharacterFacade.html">CharacterFacade</a></td>
+        <td></td>
+      </tr>
+    </tbody>
+  </table>
   <h3 id="properties">Properties
   </h3>
 

diff --git a/api/CatchIo.Runtime.Character.Receivers.CharacterFeetDamageReceiver.html b/api/CatchIo.Runtime.Character.Receivers.CharacterFeetDamageReceiver.html
@@ -100,6 +100,9 @@ <h5>Implements</h5>
   </div>
   <div class="inheritedMembers">
     <h5>Inherited Members</h5>
+    <div>
+      <a class="xref" href="CatchIo.Runtime.Character.Receivers.CharacterDamageReceiver.html#CatchIo_Runtime_Character_Receivers_CharacterDamageReceiver__character">CharacterDamageReceiver._character</a>
+    </div>
     <div>
       <a class="xref" href="CatchIo.Runtime.Character.Receivers.CharacterDamageReceiver.html#CatchIo_Runtime_Character_Receivers_CharacterDamageReceiver_IsAlive">CharacterDamageReceiver.IsAlive</a>
     </div>