Archive/portal64-still-alive
1
0
Fork 0
mirror of https://github.com/mwpenny/portal64-still-alive.git synced 2024-10-19 22:27:36 -04:00
Code Issues Actions Packages Projects Releases Wiki Activity

Update docs

Browse source
This commit is contained in:
James Lambert 2022-12-22 22:02:43 -07:00
parent 9f6891b6fd
commit 9fc4680753
8 changed files with 101 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
skelatool64/doc/index.html
View file

@ -77,7 +77,7 @@
</div> <!-- id="main" -->
<div id="about">
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
<i style="float:right;">Last updated 2022-12-21 20:18:03 </i>
<i style="float:right;">Last updated 2022-12-22 22:02:27 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>

2
skelatool64/doc/modules/sk_definition_writer.html
View file

@ -541,7 +541,7 @@
</div> <!-- id="main" -->
<div id="about">
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
<i style="float:right;">Last updated 2022-12-21 20:18:03 </i>
<i style="float:right;">Last updated 2022-12-22 22:02:27 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>

2
skelatool64/doc/modules/sk_input.html
View file

@ -135,7 +135,7 @@
</div> <!-- id="main" -->
<div id="about">
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
<i style="float:right;">Last updated 2022-12-21 20:18:03 </i>
<i style="float:right;">Last updated 2022-12-22 22:02:27 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>

95
skelatool64/doc/modules/sk_math.html
View file

@ -143,6 +143,14 @@
<td class="summary">Returns the point inside or on the box that is nearest to the given point</td>
</tr>
<tr>
<td class="name" nowrap><a href="#Box3:overlaps">Box3:overlaps (box_or_point)</a></td>
<td class="summary">Returns the point inside or on the box that is nearest to the given point</td>
</tr>
<tr>
<td class="name" nowrap><a href="#Box3:__mul">Box3:__mul (b)</a></td>
<td class="summary"></td>
</tr>
<tr>
<td class="name" nowrap><a href="#Box3:distance_to_point">Box3:distance_to_point (point)</a></td>
<td class="summary">Gets the distance from the box to the point
If the box contains the point then the negative distance to
@ -152,6 +160,10 @@
<td class="name" nowrap><a href="#Box3:lerp">Box3:lerp ()</a></td>
<td class="summary">Linearly interpolates between the min and max of the box</td>
</tr>
<tr>
<td class="name" nowrap><a href="#Box3:union">Box3:union (box_or_point)</a></td>
<td class="summary">Linearly interpolates between the min and max of the box</td>
</tr>
</table>
<h2><a href="#Class_Quaternion">Class Quaternion </a></h2>
<table class="function_list">
@ -691,6 +703,60 @@
</dd>
<dt>
<a name = "Box3:overlaps"></a>
<strong>Box3:overlaps (box_or_point)</strong>
</dt>
<dd>
Returns the point inside or on the box that is nearest to the given point
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">box_or_point</span>
<span class="types"><a class="type" href="../modules/sk_math.html#Vector3">Vector3</a> or <a class="type" href="../modules/sk_math.html#Box3">Box3</a></span>
</li>
</ul>
<h3>Returns:</h3>
<ol>
<span class="types"><span class="type">boolean</span></span>
</ol>
</dd>
<dt>
<a name = "Box3:__mul"></a>
<strong>Box3:__mul (b)</strong>
</dt>
<dd>
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">b</span>
<span class="types"><span class="type">number</span> or <a class="type" href="../modules/sk_math.html#Box3">Box3</a></span>
</li>
</ul>
<h3>Returns:</h3>
<ol>
<span class="types"><a class="type" href="../modules/sk_math.html#Box3">Box3</a></span>
</ol>
</dd>
<dt>
<a name = "Box3:distance_to_point"></a>
@ -740,6 +806,33 @@
</dd>
<dt>
<a name = "Box3:union"></a>
<strong>Box3:union (box_or_point)</strong>
</dt>
<dd>
Linearly interpolates between the min and max of the box
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">box_or_point</span>
<span class="types"><a class="type" href="../modules/sk_math.html#Vector3">Vector3</a> or <a class="type" href="../modules/sk_math.html#Box3">Box3</a></span>
</li>
</ul>
<h3>Returns:</h3>
<ol>
<span class="types"><a class="type" href="../modules/sk_math.html#Box3">Box3</a></span>
</ol>
</dd>
</dl>
<h2 class="section-header "><a name="Class_Quaternion"></a>Class Quaternion </h2>
@ -772,7 +865,7 @@
</div> <!-- id="main" -->
<div id="about">
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
<i style="float:right;">Last updated 2022-12-21 20:18:03 </i>
<i style="float:right;">Last updated 2022-12-22 22:02:27 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>

2
skelatool64/doc/modules/sk_mesh.html
View file

@ -302,7 +302,7 @@
</div> <!-- id="main" -->
<div id="about">
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
<i style="float:right;">Last updated 2022-12-21 20:18:03 </i>
<i style="float:right;">Last updated 2022-12-22 22:02:27 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>

2
skelatool64/doc/modules/sk_scene.html
View file

@ -296,7 +296,7 @@
</div> <!-- id="main" -->
<div id="about">
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
<i style="float:right;">Last updated 2022-12-21 20:18:03 </i>
<i style="float:right;">Last updated 2022-12-22 22:02:27 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>

2
skelatool64/doc/modules/sk_transform.html
View file

@ -106,7 +106,7 @@
</div> <!-- id="main" -->
<div id="about">
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
<i style="float:right;">Last updated 2022-12-21 20:18:03 </i>
<i style="float:right;">Last updated 2022-12-22 22:02:27 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>

2
skelatool64/lua/sk_math.lua
View file

@ -262,7 +262,7 @@ function Box3.overlaps(box, box_or_point)
end
--- @function __mul
--- @tparam number|Box3
--- @tparam number|Box3 b
--- @treturn Box3
function Box3.__mul(a, b)
if type(a) == 'number' then