Archive/TombEngine
0
0
Fork 0
mirror of https://github.com/TombEngine/TombEngine.git synced 2025-05-07 11:13:53 +03:00
Code Issues Projects Releases Packages Wiki Activity Actions

Update docs.

Browse source
This commit is contained in:
hispidence 2022-09-14 20:05:31 +01:00
parent f1318293fd
commit a9bdd74183
29 changed files with 174 additions and 62 deletions
Download patch file Download diff file Expand all files Collapse all files

3
Documentation/doc/1 modules/Effects.html
View file

@ -78,7 +78,6 @@
<ul class="nowrap"> <ul class="nowrap">
<li><a href="../5 lua utility modules/EventSequence.html">EventSequence</a></li> <li><a href="../5 lua utility modules/EventSequence.html">EventSequence</a></li>
<li><a href="../5 lua utility modules/Timer.html">Timer</a></li> <li><a href="../5 lua utility modules/Timer.html">Timer</a></li>
<li><a href="../5 lua utility modules/Util.html">Util</a></li>
</ul> </ul>
</div> </div>
@ -510,7 +509,7 @@
</div> <!-- id="main" --> </div> <!-- id="main" -->
<div id="about"> <div id="about">
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i> <i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
<i style="float:right;">Last updated 2022-09-13 21:22:35 </i> <i style="float:right;">Last updated 2022-09-14 20:04:13 </i>
</div> <!-- id="about" --> </div> <!-- id="about" -->
</div> <!-- id="container" --> </div> <!-- id="container" -->
</body> </body>

3
Documentation/doc/1 modules/Flow.html
View file

@ -80,7 +80,6 @@
<ul class="nowrap"> <ul class="nowrap">
<li><a href="../5 lua utility modules/EventSequence.html">EventSequence</a></li> <li><a href="../5 lua utility modules/EventSequence.html">EventSequence</a></li>
<li><a href="../5 lua utility modules/Timer.html">Timer</a></li> <li><a href="../5 lua utility modules/Timer.html">Timer</a></li>
<li><a href="../5 lua utility modules/Util.html">Util</a></li>
</ul> </ul>
</div> </div>
@ -513,7 +512,7 @@ Specify which translations in the strings table correspond to which languages.
</div> <!-- id="main" --> </div> <!-- id="main" -->
<div id="about"> <div id="about">
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i> <i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
<i style="float:right;">Last updated 2022-09-13 21:22:35 </i> <i style="float:right;">Last updated 2022-09-14 20:04:13 </i>
</div> <!-- id="about" --> </div> <!-- id="about" -->
</div> <!-- id="container" --> </div> <!-- id="container" -->
</body> </body>

3
Documentation/doc/1 modules/Inventory.html
View file

@ -78,7 +78,6 @@
<ul class="nowrap"> <ul class="nowrap">
<li><a href="../5 lua utility modules/EventSequence.html">EventSequence</a></li> <li><a href="../5 lua utility modules/EventSequence.html">EventSequence</a></li>
<li><a href="../5 lua utility modules/Timer.html">Timer</a></li> <li><a href="../5 lua utility modules/Timer.html">Timer</a></li>
<li><a href="../5 lua utility modules/Util.html">Util</a></li>
</ul> </ul>
</div> </div>
@ -238,7 +237,7 @@ Similar to <a href="../1 modules/Inventory.html#GiveItem">GiveItem</a> but repla
</div> <!-- id="main" --> </div> <!-- id="main" -->
<div id="about"> <div id="about">
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i> <i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
<i style="float:right;">Last updated 2022-09-13 21:22:35 </i> <i style="float:right;">Last updated 2022-09-14 20:04:13 </i>
</div> <!-- id="about" --> </div> <!-- id="about" -->
</div> <!-- id="container" --> </div> <!-- id="container" -->
</body> </body>

3
Documentation/doc/1 modules/Logic.html
View file

@ -80,7 +80,6 @@
<ul class="nowrap"> <ul class="nowrap">
<li><a href="../5 lua utility modules/EventSequence.html">EventSequence</a></li> <li><a href="../5 lua utility modules/EventSequence.html">EventSequence</a></li>
<li><a href="../5 lua utility modules/Timer.html">Timer</a></li> <li><a href="../5 lua utility modules/Timer.html">Timer</a></li>
<li><a href="../5 lua utility modules/Util.html">Util</a></li>
</ul> </ul>
</div> </div>
@ -386,7 +385,7 @@ and provides the delta time (a float representing game time since last call) via
</div> <!-- id="main" --> </div> <!-- id="main" -->
<div id="about"> <div id="about">
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i> <i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
<i style="float:right;">Last updated 2022-09-13 21:22:35 </i> <i style="float:right;">Last updated 2022-09-14 20:04:13 </i>
</div> <!-- id="about" --> </div> <!-- id="about" -->
</div> <!-- id="container" --> </div> <!-- id="container" -->
</body> </body>

75
Documentation/doc/1 modules/Misc.html
View file

@ -78,7 +78,6 @@
<ul class="nowrap"> <ul class="nowrap">
<li><a href="../5 lua utility modules/EventSequence.html">EventSequence</a></li> <li><a href="../5 lua utility modules/EventSequence.html">EventSequence</a></li>
<li><a href="../5 lua utility modules/Timer.html">Timer</a></li> <li><a href="../5 lua utility modules/Timer.html">Timer</a></li>
<li><a href="../5 lua utility modules/Util.html">Util</a></li>
</ul> </ul>
</div> </div>
@ -99,6 +98,10 @@
<td class="summary">Determine if there's a line of sight between two points.</td> <td class="summary">Determine if there's a line of sight between two points.</td>
</tr> </tr>
<tr> <tr>
<td class="name" ><a href="#Vibrate">Vibrate(strength, time)</a></td>
<td class="summary">Vibrate game controller, if function is available and setting is on.</td>
</tr>
<tr>
<td class="name" ><a href="#FadeOut">FadeOut(speed)</a></td> <td class="name" ><a href="#FadeOut">FadeOut(speed)</a></td>
<td class="summary">Do a full-screen fade-to-black.</td> <td class="summary">Do a full-screen fade-to-black.</td>
</tr> </tr>
@ -123,6 +126,14 @@
<td class="summary">Set and play an ambient track</td> <td class="summary">Set and play an ambient track</td>
</tr> </tr>
<tr> <tr>
<td class="name" ><a href="#StopAudioTracks">StopAudioTracks()</a></td>
<td class="summary">Stop any audio tracks currently playing</td>
</tr>
<tr>
<td class="name" ><a href="#StopAudioTrack">StopAudioTrack(looped)</a></td>
<td class="summary">Stop audio track that is currently playing</td>
</tr>
<tr>
<td class="name" ><a href="#PlaySound">PlaySound(sound[, position])</a></td> <td class="name" ><a href="#PlaySound">PlaySound(sound[, position])</a></td>
<td class="summary">Play sound effect</td> <td class="summary">Play sound effect</td>
</tr> </tr>
@ -220,6 +231,31 @@ eyes of the creatures would be.
<span class="global">print</span>(Misc.HasLineOfSight(enemyHead:GetRoom(), enemyHead:GetPosition(), flamePlinthPos))</pre> <span class="global">print</span>(Misc.HasLineOfSight(enemyHead:GetRoom(), enemyHead:GetPosition(), flamePlinthPos))</pre>
</ul> </ul>
</dd>
<dt>
<a name = "Vibrate"></a>
<strong>Vibrate(strength, time)</strong>
</dt>
<dd>
Vibrate game controller, if function is available and setting is on.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">strength</span>
<span class="types"><span class="type">float</span></span>
Strength of the vibration
</li>
<li><span class="parameter">time</span>
<span class="types"><span class="type">float</span></span>
<strong>(default 0.3)</strong> Time of the vibration, in seconds
</li>
</ul>
</dd> </dd>
<dt> <dt>
<a name = "FadeOut"></a> <a name = "FadeOut"></a>
@ -354,6 +390,41 @@ eyes of the creatures would be.
</dd>
<dt>
<a name = "StopAudioTracks"></a>
<strong>StopAudioTracks()</strong>
</dt>
<dd>
Stop any audio tracks currently playing
</dd>
<dt>
<a name = "StopAudioTrack"></a>
<strong>StopAudioTrack(looped)</strong>
</dt>
<dd>
Stop audio track that is currently playing
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">looped</span>
<span class="types"><span class="type">bool</span></span>
if set, stop looped audio track, if not, stop one-shot audio track
</li>
</ul>
</dd> </dd>
<dt> <dt>
<a name = "PlaySound"></a> <a name = "PlaySound"></a>
@ -642,7 +713,7 @@ To be used with <a href="../2 classes/Strings.DisplayString.html#DisplayString:G
</div> <!-- id="main" --> </div> <!-- id="main" -->
<div id="about"> <div id="about">
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i> <i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
<i style="float:right;">Last updated 2022-09-13 21:22:35 </i> <i style="float:right;">Last updated 2022-09-14 20:04:13 </i>
</div> <!-- id="about" --> </div> <!-- id="about" -->
</div> <!-- id="container" --> </div> <!-- id="container" -->
</body> </body>

3
Documentation/doc/1 modules/Objects.html
View file

@ -78,7 +78,6 @@
<ul class="nowrap"> <ul class="nowrap">
<li><a href="../5 lua utility modules/EventSequence.html">EventSequence</a></li> <li><a href="../5 lua utility modules/EventSequence.html">EventSequence</a></li>
<li><a href="../5 lua utility modules/Timer.html">Timer</a></li> <li><a href="../5 lua utility modules/Timer.html">Timer</a></li>
<li><a href="../5 lua utility modules/Util.html">Util</a></li>
</ul> </ul>
</div> </div>
@ -296,7 +295,7 @@
</div> <!-- id="main" --> </div> <!-- id="main" -->
<div id="about"> <div id="about">
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i> <i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
<i style="float:right;">Last updated 2022-09-13 21:22:35 </i> <i style="float:right;">Last updated 2022-09-14 20:04:13 </i>
</div> <!-- id="about" --> </div> <!-- id="about" -->
</div> <!-- id="container" --> </div> <!-- id="container" -->
</body> </body>

3
Documentation/doc/1 modules/Strings.html
View file

@ -78,7 +78,6 @@
<ul class="nowrap"> <ul class="nowrap">
<li><a href="../5 lua utility modules/EventSequence.html">EventSequence</a></li> <li><a href="../5 lua utility modules/EventSequence.html">EventSequence</a></li>
<li><a href="../5 lua utility modules/Timer.html">Timer</a></li> <li><a href="../5 lua utility modules/Timer.html">Timer</a></li>
<li><a href="../5 lua utility modules/Util.html">Util</a></li>
</ul> </ul>
</div> </div>
@ -168,7 +167,7 @@ with a call to <a href="../1 modules/Strings.html#ShowString">ShowString</a>, or
</div> <!-- id="main" --> </div> <!-- id="main" -->
<div id="about"> <div id="about">
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i> <i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
<i style="float:right;">Last updated 2022-09-13 21:22:35 </i> <i style="float:right;">Last updated 2022-09-14 20:04:13 </i>
</div> <!-- id="about" --> </div> <!-- id="about" -->
</div> <!-- id="container" --> </div> <!-- id="container" -->
</body> </body>

3
Documentation/doc/2 classes/Flow.Animations.html
View file

@ -74,7 +74,6 @@
<ul class="nowrap"> <ul class="nowrap">
<li><a href="../5 lua utility modules/EventSequence.html">EventSequence</a></li> <li><a href="../5 lua utility modules/EventSequence.html">EventSequence</a></li>
<li><a href="../5 lua utility modules/Timer.html">Timer</a></li> <li><a href="../5 lua utility modules/Timer.html">Timer</a></li>
<li><a href="../5 lua utility modules/Util.html">Util</a></li>
</ul> </ul>
</div> </div>
@ -99,7 +98,7 @@
</div> <!-- id="main" --> </div> <!-- id="main" -->
<div id="about"> <div id="about">
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i> <i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
<i style="float:right;">Last updated 2022-09-13 21:22:35 </i> <i style="float:right;">Last updated 2022-09-14 20:04:13 </i>
</div> <!-- id="about" --> </div> <!-- id="about" -->
</div> <!-- id="container" --> </div> <!-- id="container" -->
</body> </body>

3
Documentation/doc/2 classes/Flow.Fog.html
View file

@ -79,7 +79,6 @@
<ul class="nowrap"> <ul class="nowrap">
<li><a href="../5 lua utility modules/EventSequence.html">EventSequence</a></li> <li><a href="../5 lua utility modules/EventSequence.html">EventSequence</a></li>
<li><a href="../5 lua utility modules/Timer.html">Timer</a></li> <li><a href="../5 lua utility modules/Timer.html">Timer</a></li>
<li><a href="../5 lua utility modules/Util.html">Util</a></li>
</ul> </ul>
</div> </div>
@ -226,7 +225,7 @@
</div> <!-- id="main" --> </div> <!-- id="main" -->
<div id="about"> <div id="about">
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i> <i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
<i style="float:right;">Last updated 2022-09-13 21:22:35 </i> <i style="float:right;">Last updated 2022-09-14 20:04:13 </i>
</div> <!-- id="about" --> </div> <!-- id="about" -->
</div> <!-- id="container" --> </div> <!-- id="container" -->
</body> </body>

3
Documentation/doc/2 classes/Flow.InventoryItem.html
View file

@ -78,7 +78,6 @@
<ul class="nowrap"> <ul class="nowrap">
<li><a href="../5 lua utility modules/EventSequence.html">EventSequence</a></li> <li><a href="../5 lua utility modules/EventSequence.html">EventSequence</a></li>
<li><a href="../5 lua utility modules/Timer.html">Timer</a></li> <li><a href="../5 lua utility modules/Timer.html">Timer</a></li>
<li><a href="../5 lua utility modules/Util.html">Util</a></li>
</ul> </ul>
</div> </div>
@ -181,7 +180,7 @@ EXAMINE
</div> <!-- id="main" --> </div> <!-- id="main" -->
<div id="about"> <div id="about">
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i> <i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
<i style="float:right;">Last updated 2022-09-13 21:22:35 </i> <i style="float:right;">Last updated 2022-09-14 20:04:13 </i>
</div> <!-- id="about" --> </div> <!-- id="about" -->
</div> <!-- id="container" --> </div> <!-- id="container" -->
</body> </body>

3
Documentation/doc/2 classes/Flow.Level.html
View file

@ -79,7 +79,6 @@
<ul class="nowrap"> <ul class="nowrap">
<li><a href="../5 lua utility modules/EventSequence.html">EventSequence</a></li> <li><a href="../5 lua utility modules/EventSequence.html">EventSequence</a></li>
<li><a href="../5 lua utility modules/Timer.html">Timer</a></li> <li><a href="../5 lua utility modules/Timer.html">Timer</a></li>
<li><a href="../5 lua utility modules/Util.html">Util</a></li>
</ul> </ul>
</div> </div>
@ -495,7 +494,7 @@ Must be at least 4.</p>
</div> <!-- id="main" --> </div> <!-- id="main" -->
<div id="about"> <div id="about">
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i> <i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
<i style="float:right;">Last updated 2022-09-13 21:22:35 </i> <i style="float:right;">Last updated 2022-09-14 20:04:13 </i>
</div> <!-- id="about" --> </div> <!-- id="about" -->
</div> <!-- id="container" --> </div> <!-- id="container" -->
</body> </body>

3
Documentation/doc/2 classes/Flow.Mirror.html
View file

@ -74,7 +74,6 @@
<ul class="nowrap"> <ul class="nowrap">
<li><a href="../5 lua utility modules/EventSequence.html">EventSequence</a></li> <li><a href="../5 lua utility modules/EventSequence.html">EventSequence</a></li>
<li><a href="../5 lua utility modules/Timer.html">Timer</a></li> <li><a href="../5 lua utility modules/Timer.html">Timer</a></li>
<li><a href="../5 lua utility modules/Util.html">Util</a></li>
</ul> </ul>
</div> </div>
@ -99,7 +98,7 @@
</div> <!-- id="main" --> </div> <!-- id="main" -->
<div id="about"> <div id="about">
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i> <i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
<i style="float:right;">Last updated 2022-09-13 21:22:35 </i> <i style="float:right;">Last updated 2022-09-14 20:04:13 </i>
</div> <!-- id="about" --> </div> <!-- id="about" -->
</div> <!-- id="container" --> </div> <!-- id="container" -->
</body> </body>

3
Documentation/doc/2 classes/Flow.Settings.html
View file

@ -78,7 +78,6 @@
<ul class="nowrap"> <ul class="nowrap">
<li><a href="../5 lua utility modules/EventSequence.html">EventSequence</a></li> <li><a href="../5 lua utility modules/EventSequence.html">EventSequence</a></li>
<li><a href="../5 lua utility modules/Timer.html">Timer</a></li> <li><a href="../5 lua utility modules/Timer.html">Timer</a></li>
<li><a href="../5 lua utility modules/Util.html">Util</a></li>
</ul> </ul>
</div> </div>
@ -142,7 +141,7 @@ has an unrecoverable error, the game will close.
</div> <!-- id="main" --> </div> <!-- id="main" -->
<div id="about"> <div id="about">
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i> <i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
<i style="float:right;">Last updated 2022-09-13 21:22:35 </i> <i style="float:right;">Last updated 2022-09-14 20:04:13 </i>
</div> <!-- id="about" --> </div> <!-- id="about" -->
</div> <!-- id="container" --> </div> <!-- id="container" -->
</body> </body>

3
Documentation/doc/2 classes/Flow.SkyLayer.html
View file

@ -79,7 +79,6 @@
<ul class="nowrap"> <ul class="nowrap">
<li><a href="../5 lua utility modules/EventSequence.html">EventSequence</a></li> <li><a href="../5 lua utility modules/EventSequence.html">EventSequence</a></li>
<li><a href="../5 lua utility modules/Timer.html">Timer</a></li> <li><a href="../5 lua utility modules/Timer.html">Timer</a></li>
<li><a href="../5 lua utility modules/Util.html">Util</a></li>
</ul> </ul>
</div> </div>
@ -198,7 +197,7 @@ Less is more. City of The Dead, for example, uses a speed value of 16.
</div> <!-- id="main" --> </div> <!-- id="main" -->
<div id="about"> <div id="about">
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i> <i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
<i style="float:right;">Last updated 2022-09-13 21:22:35 </i> <i style="float:right;">Last updated 2022-09-14 20:04:13 </i>
</div> <!-- id="about" --> </div> <!-- id="about" -->
</div> <!-- id="container" --> </div> <!-- id="container" -->
</body> </body>

3
Documentation/doc/2 classes/Objects.AIObject.html
View file

@ -78,7 +78,6 @@
<ul class="nowrap"> <ul class="nowrap">
<li><a href="../5 lua utility modules/EventSequence.html">EventSequence</a></li> <li><a href="../5 lua utility modules/EventSequence.html">EventSequence</a></li>
<li><a href="../5 lua utility modules/Timer.html">Timer</a></li> <li><a href="../5 lua utility modules/Timer.html">Timer</a></li>
<li><a href="../5 lua utility modules/Util.html">Util</a></li>
</ul> </ul>
</div> </div>
@ -371,7 +370,7 @@ aiObj:SetObjectID(TEN.Objects.ObjID.AI_PATROL1)</pre>
</div> <!-- id="main" --> </div> <!-- id="main" -->
<div id="about"> <div id="about">
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i> <i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
<i style="float:right;">Last updated 2022-09-13 21:22:35 </i> <i style="float:right;">Last updated 2022-09-14 20:04:13 </i>
</div> <!-- id="about" --> </div> <!-- id="about" -->
</div> <!-- id="container" --> </div> <!-- id="container" -->
</body> </body>

3
Documentation/doc/2 classes/Objects.Camera.html
View file

@ -78,7 +78,6 @@
<ul class="nowrap"> <ul class="nowrap">
<li><a href="../5 lua utility modules/EventSequence.html">EventSequence</a></li> <li><a href="../5 lua utility modules/EventSequence.html">EventSequence</a></li>
<li><a href="../5 lua utility modules/Timer.html">Timer</a></li> <li><a href="../5 lua utility modules/Timer.html">Timer</a></li>
<li><a href="../5 lua utility modules/Util.html">Util</a></li>
</ul> </ul>
</div> </div>
@ -259,7 +258,7 @@
</div> <!-- id="main" --> </div> <!-- id="main" -->
<div id="about"> <div id="about">
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i> <i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
<i style="float:right;">Last updated 2022-09-13 21:22:35 </i> <i style="float:right;">Last updated 2022-09-14 20:04:13 </i>
</div> <!-- id="about" --> </div> <!-- id="about" -->
</div> <!-- id="container" --> </div> <!-- id="container" -->
</body> </body>

3
Documentation/doc/2 classes/Objects.Moveable.html
View file

@ -78,7 +78,6 @@
<ul class="nowrap"> <ul class="nowrap">
<li><a href="../5 lua utility modules/EventSequence.html">EventSequence</a></li> <li><a href="../5 lua utility modules/EventSequence.html">EventSequence</a></li>
<li><a href="../5 lua utility modules/Timer.html">Timer</a></li> <li><a href="../5 lua utility modules/Timer.html">Timer</a></li>
<li><a href="../5 lua utility modules/Util.html">Util</a></li>
</ul> </ul>
</div> </div>
@ -1479,7 +1478,7 @@ sas:SetPosition(destinationPosition, <span class="keyword">false</span>)</pre>
</div> <!-- id="main" --> </div> <!-- id="main" -->
<div id="about"> <div id="about">
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i> <i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
<i style="float:right;">Last updated 2022-09-13 21:22:35 </i> <i style="float:right;">Last updated 2022-09-14 20:04:13 </i>
</div> <!-- id="about" --> </div> <!-- id="about" -->
</div> <!-- id="container" --> </div> <!-- id="container" -->
</body> </body>

3
Documentation/doc/2 classes/Objects.Sink.html
View file

@ -78,7 +78,6 @@
<ul class="nowrap"> <ul class="nowrap">
<li><a href="../5 lua utility modules/EventSequence.html">EventSequence</a></li> <li><a href="../5 lua utility modules/EventSequence.html">EventSequence</a></li>
<li><a href="../5 lua utility modules/Timer.html">Timer</a></li> <li><a href="../5 lua utility modules/Timer.html">Timer</a></li>
<li><a href="../5 lua utility modules/Util.html">Util</a></li>
</ul> </ul>
</div> </div>
@ -261,7 +260,7 @@
</div> <!-- id="main" --> </div> <!-- id="main" -->
<div id="about"> <div id="about">
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i> <i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
<i style="float:right;">Last updated 2022-09-13 21:22:35 </i> <i style="float:right;">Last updated 2022-09-14 20:04:13 </i>
</div> <!-- id="about" --> </div> <!-- id="about" -->
</div> <!-- id="container" --> </div> <!-- id="container" -->
</body> </body>

3
Documentation/doc/2 classes/Objects.SoundSource.html
View file

@ -78,7 +78,6 @@
<ul class="nowrap"> <ul class="nowrap">
<li><a href="../5 lua utility modules/EventSequence.html">EventSequence</a></li> <li><a href="../5 lua utility modules/EventSequence.html">EventSequence</a></li>
<li><a href="../5 lua utility modules/Timer.html">Timer</a></li> <li><a href="../5 lua utility modules/Timer.html">Timer</a></li>
<li><a href="../5 lua utility modules/Util.html">Util</a></li>
</ul> </ul>
</div> </div>
@ -259,7 +258,7 @@
</div> <!-- id="main" --> </div> <!-- id="main" -->
<div id="about"> <div id="about">
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i> <i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
<i style="float:right;">Last updated 2022-09-13 21:22:35 </i> <i style="float:right;">Last updated 2022-09-14 20:04:13 </i>
</div> <!-- id="about" --> </div> <!-- id="about" -->
</div> <!-- id="container" --> </div> <!-- id="container" -->
</body> </body>

76
Documentation/doc/2 classes/Objects.Static.html
View file

@ -78,7 +78,6 @@
<ul class="nowrap"> <ul class="nowrap">
<li><a href="../5 lua utility modules/EventSequence.html">EventSequence</a></li> <li><a href="../5 lua utility modules/EventSequence.html">EventSequence</a></li>
<li><a href="../5 lua utility modules/Timer.html">Timer</a></li> <li><a href="../5 lua utility modules/Timer.html">Timer</a></li>
<li><a href="../5 lua utility modules/Util.html">Util</a></li>
</ul> </ul>
</div> </div>
@ -103,6 +102,18 @@
<td class="summary">Disable the static</td> <td class="summary">Disable the static</td>
</tr> </tr>
<tr> <tr>
<td class="name" ><a href="#Static:GetActive">Static:GetActive()</a></td>
<td class="summary">Get static mesh visibility</td>
</tr>
<tr>
<td class="name" ><a href="#Static:GetSolid">Static:GetSolid()</a></td>
<td class="summary">Get static mesh solid collision state</td>
</tr>
<tr>
<td class="name" ><a href="#Static:SetSolid">Static:SetSolid(if)</a></td>
<td class="summary">Set static mesh solid collision state</td>
</tr>
<tr>
<td class="name" ><a href="#Static:GetPosition">Static:GetPosition()</a></td> <td class="name" ><a href="#Static:GetPosition">Static:GetPosition()</a></td>
<td class="summary">Get the static's position</td> <td class="summary">Get the static's position</td>
</tr> </tr>
@ -191,6 +202,67 @@
</dd>
<dt>
<a name = "Static:GetActive"></a>
<strong>Static:GetActive()</strong>
</dt>
<dd>
Get static mesh visibility
<h3>Returns:</h3>
<ol>
<span class="types"><span class="type">bool</span></span>
visibility state
</ol>
</dd>
<dt>
<a name = "Static:GetSolid"></a>
<strong>Static:GetSolid()</strong>
</dt>
<dd>
Get static mesh solid collision state
<h3>Returns:</h3>
<ol>
<span class="types"><span class="type">bool</span></span>
solid collision state (true if solid, false if soft)
</ol>
</dd>
<dt>
<a name = "Static:SetSolid"></a>
<strong>Static:SetSolid(if)</strong>
</dt>
<dd>
Set static mesh solid collision state
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">if</span>
<span class="types"><span class="type">bool</span></span>
set, collision will be solid, if not, will be soft
</li>
</ul>
</dd> </dd>
<dt> <dt>
<a name = "Static:GetPosition"></a> <a name = "Static:GetPosition"></a>
@ -460,7 +532,7 @@
</div> <!-- id="main" --> </div> <!-- id="main" -->
<div id="about"> <div id="about">
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i> <i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
<i style="float:right;">Last updated 2022-09-13 21:22:35 </i> <i style="float:right;">Last updated 2022-09-14 20:04:13 </i>
</div> <!-- id="about" --> </div> <!-- id="about" -->
</div> <!-- id="container" --> </div> <!-- id="container" -->
</body> </body>

3
Documentation/doc/2 classes/Strings.DisplayString.html
View file

@ -78,7 +78,6 @@
<ul class="nowrap"> <ul class="nowrap">
<li><a href="../5 lua utility modules/EventSequence.html">EventSequence</a></li> <li><a href="../5 lua utility modules/EventSequence.html">EventSequence</a></li>
<li><a href="../5 lua utility modules/Timer.html">Timer</a></li> <li><a href="../5 lua utility modules/Timer.html">Timer</a></li>
<li><a href="../5 lua utility modules/Util.html">Util</a></li>
</ul> </ul>
</div> </div>
@ -306,7 +305,7 @@ TEN.Strings.DisplayStringOption.SHADOW -- will give the text a small shadow
</div> <!-- id="main" --> </div> <!-- id="main" -->
<div id="about"> <div id="about">
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i> <i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
<i style="float:right;">Last updated 2022-09-13 21:22:35 </i> <i style="float:right;">Last updated 2022-09-14 20:04:13 </i>
</div> <!-- id="about" --> </div> <!-- id="about" -->
</div> <!-- id="container" --> </div> <!-- id="container" -->
</body> </body>

3
Documentation/doc/3 primitive classes/Color.html
View file

@ -79,7 +79,6 @@
<ul class="nowrap"> <ul class="nowrap">
<li><a href="../5 lua utility modules/EventSequence.html">EventSequence</a></li> <li><a href="../5 lua utility modules/EventSequence.html">EventSequence</a></li>
<li><a href="../5 lua utility modules/Timer.html">Timer</a></li> <li><a href="../5 lua utility modules/Timer.html">Timer</a></li>
<li><a href="../5 lua utility modules/Util.html">Util</a></li>
</ul> </ul>
</div> </div>
@ -311,7 +310,7 @@
</div> <!-- id="main" --> </div> <!-- id="main" -->
<div id="about"> <div id="about">
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i> <i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
<i style="float:right;">Last updated 2022-09-13 21:22:35 </i> <i style="float:right;">Last updated 2022-09-14 20:04:13 </i>
</div> <!-- id="about" --> </div> <!-- id="about" -->
</div> <!-- id="container" --> </div> <!-- id="container" -->
</body> </body>

3
Documentation/doc/3 primitive classes/Rotation.html
View file

@ -79,7 +79,6 @@
<ul class="nowrap"> <ul class="nowrap">
<li><a href="../5 lua utility modules/EventSequence.html">EventSequence</a></li> <li><a href="../5 lua utility modules/EventSequence.html">EventSequence</a></li>
<li><a href="../5 lua utility modules/Timer.html">Timer</a></li> <li><a href="../5 lua utility modules/Timer.html">Timer</a></li>
<li><a href="../5 lua utility modules/Util.html">Util</a></li>
</ul> </ul>
</div> </div>
@ -249,7 +248,7 @@ All values will be clamped to [-32768, 32767].</p>
</div> <!-- id="main" --> </div> <!-- id="main" -->
<div id="about"> <div id="about">
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i> <i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
<i style="float:right;">Last updated 2022-09-13 21:22:35 </i> <i style="float:right;">Last updated 2022-09-14 20:04:13 </i>
</div> <!-- id="about" --> </div> <!-- id="about" -->
</div> <!-- id="container" --> </div> <!-- id="container" -->
</body> </body>

3
Documentation/doc/3 primitive classes/Vec3.html
View file

@ -79,7 +79,6 @@
<ul class="nowrap"> <ul class="nowrap">
<li><a href="../5 lua utility modules/EventSequence.html">EventSequence</a></li> <li><a href="../5 lua utility modules/EventSequence.html">EventSequence</a></li>
<li><a href="../5 lua utility modules/Timer.html">Timer</a></li> <li><a href="../5 lua utility modules/Timer.html">Timer</a></li>
<li><a href="../5 lua utility modules/Util.html">Util</a></li>
</ul> </ul>
</div> </div>
@ -276,7 +275,7 @@ However, this function would return it as (0, 1, 1).
</div> <!-- id="main" --> </div> <!-- id="main" -->
<div id="about"> <div id="about">
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i> <i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
<i style="float:right;">Last updated 2022-09-13 21:22:35 </i> <i style="float:right;">Last updated 2022-09-14 20:04:13 </i>
</div> <!-- id="about" --> </div> <!-- id="about" -->
</div> <!-- id="container" --> </div> <!-- id="container" -->
</body> </body>

3
Documentation/doc/4 enums/Effects.BlendID.html
View file

@ -78,7 +78,6 @@
<ul class="nowrap"> <ul class="nowrap">
<li><a href="../5 lua utility modules/EventSequence.html">EventSequence</a></li> <li><a href="../5 lua utility modules/EventSequence.html">EventSequence</a></li>
<li><a href="../5 lua utility modules/Timer.html">Timer</a></li> <li><a href="../5 lua utility modules/Timer.html">Timer</a></li>
<li><a href="../5 lua utility modules/Util.html">Util</a></li>
</ul> </ul>
</div> </div>
@ -148,7 +147,7 @@ ALPHABLEND
</div> <!-- id="main" --> </div> <!-- id="main" -->
<div id="about"> <div id="about">
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i> <i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
<i style="float:right;">Last updated 2022-09-13 21:22:35 </i> <i style="float:right;">Last updated 2022-09-14 20:04:13 </i>
</div> <!-- id="about" --> </div> <!-- id="about" -->
</div> <!-- id="container" --> </div> <!-- id="container" -->
</body> </body>

3
Documentation/doc/4 enums/Objects.ObjID.html
View file

@ -78,7 +78,6 @@
<ul class="nowrap"> <ul class="nowrap">
<li><a href="../5 lua utility modules/EventSequence.html">EventSequence</a></li> <li><a href="../5 lua utility modules/EventSequence.html">EventSequence</a></li>
<li><a href="../5 lua utility modules/Timer.html">Timer</a></li> <li><a href="../5 lua utility modules/Timer.html">Timer</a></li>
<li><a href="../5 lua utility modules/Util.html">Util</a></li>
</ul> </ul>
</div> </div>
@ -1308,7 +1307,7 @@ PC_SAVE_INV_ITEM
</div> <!-- id="main" --> </div> <!-- id="main" -->
<div id="about"> <div id="about">
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i> <i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
<i style="float:right;">Last updated 2022-09-13 21:22:35 </i> <i style="float:right;">Last updated 2022-09-14 20:04:13 </i>
</div> <!-- id="about" --> </div> <!-- id="about" -->
</div> <!-- id="container" --> </div> <!-- id="container" -->
</body> </body>

3
Documentation/doc/5 lua utility modules/EventSequence.html
View file

@ -40,7 +40,6 @@
<ul class="nowrap"> <ul class="nowrap">
<li><strong>EventSequence</strong></li> <li><strong>EventSequence</strong></li>
<li><a href="../5 lua utility modules/Timer.html">Timer</a></li> <li><a href="../5 lua utility modules/Timer.html">Timer</a></li>
<li><a href="../5 lua utility modules/Util.html">Util</a></li>
</ul> </ul>
<h2>1 Modules</h2> <h2>1 Modules</h2>
<ul class="nowrap"> <ul class="nowrap">
@ -330,7 +329,7 @@ LevelFuncs.SpawnBaddy = <span class="keyword">function</span>(baddy, name, pos)
</div> <!-- id="main" --> </div> <!-- id="main" -->
<div id="about"> <div id="about">
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i> <i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
<i style="float:right;">Last updated 2022-09-13 21:22:35 </i> <i style="float:right;">Last updated 2022-09-14 20:04:13 </i>
</div> <!-- id="about" --> </div> <!-- id="about" -->
</div> <!-- id="container" --> </div> <!-- id="container" -->
</body> </body>

3
Documentation/doc/5 lua utility modules/Timer.html
View file

@ -40,7 +40,6 @@
<ul class="nowrap"> <ul class="nowrap">
<li><a href="../5 lua utility modules/EventSequence.html">EventSequence</a></li> <li><a href="../5 lua utility modules/EventSequence.html">EventSequence</a></li>
<li><strong>Timer</strong></li> <li><strong>Timer</strong></li>
<li><a href="../5 lua utility modules/Util.html">Util</a></li>
</ul> </ul>
<h2>1 Modules</h2> <h2>1 Modules</h2>
<ul class="nowrap"> <ul class="nowrap">
@ -495,7 +494,7 @@ local myTimeFormat4 = {seconds = true}
</div> <!-- id="main" --> </div> <!-- id="main" -->
<div id="about"> <div id="about">
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i> <i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
<i style="float:right;">Last updated 2022-09-13 21:22:35 </i> <i style="float:right;">Last updated 2022-09-14 20:04:13 </i>
</div> <!-- id="about" --> </div> <!-- id="about" -->
</div> <!-- id="container" --> </div> <!-- id="container" -->
</body> </body>

7
Documentation/doc/index.html
View file

@ -71,7 +71,6 @@
<ul class="nowrap"> <ul class="nowrap">
<li><a href="5 lua utility modules/EventSequence.html">EventSequence</a></li> <li><a href="5 lua utility modules/EventSequence.html">EventSequence</a></li>
<li><a href="5 lua utility modules/Timer.html">Timer</a></li> <li><a href="5 lua utility modules/Timer.html">Timer</a></li>
<li><a href="5 lua utility modules/Util.html">Util</a></li>
</ul> </ul>
</div> </div>
@ -227,17 +226,13 @@ local door = GetMoveableByName("door_type4_14")
<td class="name" ><a href="5 lua utility modules/Timer.html">Timer</a></td> <td class="name" ><a href="5 lua utility modules/Timer.html">Timer</a></td>
<td class="summary">Basic timer - after a specified number of seconds, the specified thing happens.</td> <td class="summary">Basic timer - after a specified number of seconds, the specified thing happens.</td>
</tr> </tr>
<tr>
<td class="name" ><a href="5 lua utility modules/Util.html">Util</a></td>
<td class="summary">Misc Util functions</td>
</tr>
</table> </table>
</div> <!-- id="content" --> </div> <!-- id="content" -->
</div> <!-- id="main" --> </div> <!-- id="main" -->
<div id="about"> <div id="about">
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i> <i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
<i style="float:right;">Last updated 2022-09-13 21:22:35 </i> <i style="float:right;">Last updated 2022-09-14 20:04:13 </i>
</div> <!-- id="about" --> </div> <!-- id="about" -->
</div> <!-- id="container" --> </div> <!-- id="container" -->
</body> </body>