mirror of
https://github.com/Reuh/ubiquitousse.git
synced 2025-10-27 17:19:31 +00:00
Improve documentation
This commit is contained in:
parent
489d0b4ba7
commit
af3bd51cb3
25 changed files with 1468 additions and 725 deletions
|
|
@ -65,13 +65,11 @@
|
|||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="modules/asset.html">asset</a></td>
|
||||
<td class="summary">Asset manager.</td>
|
||||
<td class="summary">Asset manager for Lua.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="modules/ecs.html">ecs</a></td>
|
||||
<td class="summary">ECS (entity compenent system) library</p>
|
||||
|
||||
<p> Entity Component System library, inspired by the excellent tiny-ecs.</td>
|
||||
<td class="summary">ECS (<a href="https://en.wikipedia.org/wiki/Entity_component_system">entity compenent system</a>) library for Lua.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="modules/ldtk.html">ldtk</a></td>
|
||||
|
|
@ -79,19 +77,19 @@
|
|||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="modules/scene.html">scene</a></td>
|
||||
<td class="summary">Scene management.</td>
|
||||
<td class="summary">Scene management for Lua game development.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="modules/signal.html">signal</a></td>
|
||||
<td class="summary">Signal management.</td>
|
||||
<td class="summary">Signal management for Lua.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="modules/timer.html">timer</a></td>
|
||||
<td class="summary">Time related functions.</td>
|
||||
<td class="summary">Timer management for Lua.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="modules/util.html">util</a></td>
|
||||
<td class="summary">Various functions useful for game developement.</td>
|
||||
<td class="summary">Various functions useful for Lua game developement.</td>
|
||||
</tr>
|
||||
</table>
|
||||
<h2>Topics</h2>
|
||||
|
|
@ -110,7 +108,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 2021-12-25 23:19:42 </i>
|
||||
<i style="float:right;">Last updated 2021-12-26 18:13:01 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
|
|
|
|||
|
|
@ -60,7 +60,7 @@
|
|||
<div id="content">
|
||||
|
||||
<h1>Module <code>asset</code></h1>
|
||||
<p>Asset manager.</p>
|
||||
<p>Asset manager for Lua.</p>
|
||||
<p> Loads asset and cache them.</p>
|
||||
|
||||
<p> This only provides a streamlined way to handle asset, and doesn’t handle the actual file loading/object creation itself; you are expected to provide your own asset loaders.</p>
|
||||
|
|
@ -68,6 +68,11 @@
|
|||
<p> See the <a href="../modules/asset.html#Asset:__call">Asset:__call</a> method for more details on how assets are loaded. Hopefully this will allow you to use asset which are more game-specific than “image” or “audio”.</p>
|
||||
|
||||
<p> No dependencies.</p>
|
||||
<h3>Usage:</h3>
|
||||
<ul>
|
||||
<pre class="example">TODO
|
||||
</pre>
|
||||
</ul>
|
||||
|
||||
|
||||
<h2><a href="#Functions">Functions</a></h2>
|
||||
|
|
@ -329,7 +334,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 2021-12-25 23:19:42 </i>
|
||||
<i style="float:right;">Last updated 2021-12-26 18:13:01 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
|
|
|
|||
File diff suppressed because it is too large
Load diff
File diff suppressed because it is too large
Load diff
|
|
@ -60,7 +60,7 @@
|
|||
<div id="content">
|
||||
|
||||
<h1>Module <code>scene</code></h1>
|
||||
<p>Scene management.</p>
|
||||
<p>Scene management for Lua game development.</p>
|
||||
<p><p> You can use use scenes to seperate the different states of your game: for example, a menu scene and a game scene.
|
||||
This module is fully implemented in Ubiquitousse and is mostly a “recommended way” of organising an Ubiquitousse-based game.
|
||||
However, you don’t have to use this if you don’t want to. ubiquitousse.scene handles all the differents Ubiquitousse-states and
|
||||
|
|
@ -93,6 +93,11 @@
|
|||
</ul>
|
||||
|
||||
</p>
|
||||
<h3>Usage:</h3>
|
||||
<ul>
|
||||
<pre class="example">TODO
|
||||
</pre>
|
||||
</ul>
|
||||
|
||||
|
||||
<h2><a href="#Scene_objects">Scene objects </a></h2>
|
||||
|
|
@ -103,11 +108,11 @@
|
|||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#Scene.timer">Scene.timer</a></td>
|
||||
<td class="summary">Scene-specific TimerRegistry, if uqt.time is available.</td>
|
||||
<td class="summary">Scene-specific <a href="../modules/timer.html#TimerRegistry_objects">timer.TimerRegistry</a>, if uqt.time is available.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#Scene.signal">Scene.signal</a></td>
|
||||
<td class="summary">Scene-specific SignalRegistry, if uqt.signal is available.</td>
|
||||
<td class="summary">Scene-specific <a href="../modules/signal.html#SignalRegistry_objects">signal.SignalRegistry</a>, if uqt.signal is available.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#Scene:enter">Scene:enter (...) <sup><em>[callback]</em></sup></a></td>
|
||||
|
|
@ -138,15 +143,15 @@
|
|||
<table class="function_list">
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#current">current</a></td>
|
||||
<td class="summary">The current scene object.</td>
|
||||
<td class="summary">The current <a href="../modules/scene.html#Scene_objects">Scene</a> object.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#timer">timer</a></td>
|
||||
<td class="summary">Shortcut for scene.current.timer.</td>
|
||||
<td class="summary">Shortcut for scene.current.timer, the current scene <a href="../modules/timer.html#TimerRegistry_objects">timer.TimerRegistry</a>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#signal">signal</a></td>
|
||||
<td class="summary">Shortcut for scene.current.signal.</td>
|
||||
<td class="summary">Shortcut for scene.current.signal, the current scene <code>timer.SignalRegistry</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#stack">stack</a></td>
|
||||
|
|
@ -204,6 +209,9 @@
|
|||
The scene name.
|
||||
|
||||
</ul>
|
||||
<h3>Type:</h3>
|
||||
<ul>
|
||||
<code>string</code>
|
||||
</ul>
|
||||
</ul>
|
||||
</ul>
|
||||
|
|
@ -219,9 +227,13 @@
|
|||
<strong>Scene.timer</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Scene-specific TimerRegistry, if uqt.time is available.
|
||||
Scene-specific <a href="../modules/timer.html#TimerRegistry_objects">timer.TimerRegistry</a>, if uqt.time is available.
|
||||
|
||||
</ul>
|
||||
<h3>Type:</h3>
|
||||
<ul>
|
||||
<li><code>TimerRegistry</code></li>
|
||||
<li><code>nil</code> if uqt.time unavailable</li>
|
||||
</ul>
|
||||
</ul>
|
||||
</ul>
|
||||
|
|
@ -237,9 +249,13 @@
|
|||
<strong>Scene.signal</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Scene-specific SignalRegistry, if uqt.signal is available.
|
||||
Scene-specific <a href="../modules/signal.html#SignalRegistry_objects">signal.SignalRegistry</a>, if uqt.signal is available.
|
||||
|
||||
</ul>
|
||||
<h3>Type:</h3>
|
||||
<ul>
|
||||
<li><code>SignalRegistry</code></li>
|
||||
<li><code>nil</code> if uqt.signal unavailable</li>
|
||||
</ul>
|
||||
</ul>
|
||||
</ul>
|
||||
|
|
@ -265,8 +281,7 @@
|
|||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">...</span>
|
||||
|
||||
|
||||
additional arguments passed to <a href="../modules/scene.html#switch">scene:switch</a> or <a href="../modules/scene.html#push">scene:push</a>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
|
@ -344,12 +359,11 @@
|
|||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">dt</span>
|
||||
|
||||
|
||||
<span class="types"><span class="type">number</span></span>
|
||||
the delta time
|
||||
</li>
|
||||
<li><span class="parameter">...</span>
|
||||
|
||||
|
||||
additional arguments passed to <a href="../modules/scene.html#update">scene:update</a>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
|
@ -373,8 +387,7 @@
|
|||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">...</span>
|
||||
|
||||
|
||||
additional arguments passed to <a href="../modules/scene.html#draw">scene:draw</a>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
|
@ -392,9 +405,12 @@
|
|||
<strong>current</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
The current scene object.
|
||||
The current <a href="../modules/scene.html#Scene_objects">Scene</a> object.
|
||||
|
||||
</ul>
|
||||
<h3>Type:</h3>
|
||||
<ul>
|
||||
<code>Scene</code>
|
||||
</ul>
|
||||
</ul>
|
||||
</ul>
|
||||
|
|
@ -410,9 +426,13 @@
|
|||
<strong>timer</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Shortcut for scene.current.timer.
|
||||
Shortcut for scene.current.timer, the current scene <a href="../modules/timer.html#TimerRegistry_objects">timer.TimerRegistry</a>.
|
||||
|
||||
</ul>
|
||||
<h3>Type:</h3>
|
||||
<ul>
|
||||
<li><code>TimerRegistry</code></li>
|
||||
<li><code>nil</code> if uqt.time unavailable</li>
|
||||
</ul>
|
||||
</ul>
|
||||
</ul>
|
||||
|
|
@ -428,9 +448,13 @@
|
|||
<strong>signal</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Shortcut for scene.current.signal.
|
||||
Shortcut for scene.current.signal, the current scene <code>timer.SignalRegistry</code>.
|
||||
|
||||
</ul>
|
||||
<h3>Type:</h3>
|
||||
<ul>
|
||||
<li><code>SignalRegistry</code></li>
|
||||
<li><code>nil</code> if uqt.signal unavailable</li>
|
||||
</ul>
|
||||
</ul>
|
||||
</ul>
|
||||
|
|
@ -449,6 +473,9 @@
|
|||
The scene stack: list of scene, from the farest one to the nearest.
|
||||
|
||||
</ul>
|
||||
<h3>Type:</h3>
|
||||
<ul>
|
||||
<code>{Scene,...}</code>
|
||||
</ul>
|
||||
</ul>
|
||||
</ul>
|
||||
|
|
@ -468,6 +495,9 @@
|
|||
Will search in the “scene” directory by default (<code>prefix="scene."</code>). Redefine it to fit your own ridiculous filesystem.
|
||||
|
||||
</ul>
|
||||
<h3>Type:</h3>
|
||||
<ul>
|
||||
<code>string</code>
|
||||
</ul>
|
||||
</ul>
|
||||
</ul>
|
||||
|
|
@ -628,7 +658,7 @@
|
|||
<ul>
|
||||
<li><span class="parameter">dt</span>
|
||||
<span class="types"><span class="type">number</span></span>
|
||||
the delta-time (milisecond)
|
||||
the delta-time
|
||||
</li>
|
||||
<li><span class="parameter">...</span>
|
||||
arguments to pass to the scene’s update function after dt
|
||||
|
|
@ -672,7 +702,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 2021-12-25 23:19:42 </i>
|
||||
<i style="float:right;">Last updated 2021-12-26 18:13:01 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
|
|
|
|||
|
|
@ -60,8 +60,14 @@
|
|||
<div id="content">
|
||||
|
||||
<h1>Module <code>signal</code></h1>
|
||||
<p>Signal management.</p>
|
||||
<p> No dependency.</p>
|
||||
<p>Signal management for Lua.</p>
|
||||
<p> No dependency.
|
||||
Optional dependency: LÖVE to hook into LÖVE events.</p>
|
||||
<h3>Usage:</h3>
|
||||
<ul>
|
||||
<pre class="example">TODO
|
||||
</pre>
|
||||
</ul>
|
||||
|
||||
|
||||
<h2><a href="#Module">Module </a></h2>
|
||||
|
|
@ -72,7 +78,7 @@
|
|||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#event">event</a></td>
|
||||
<td class="summary">SignalRegistry which will be used to bind signals that need to be called on game engine event; other ubiquitousse modules may bind to this registry
|
||||
<td class="summary"><a href="../modules/signal.html#SignalRegistry_objects">SignalRegistry</a> which will be used to bind signals that need to be called on game engine event; other ubiquitousse modules may bind to this registry
|
||||
if avaible.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
|
|
@ -149,7 +155,7 @@
|
|||
<strong>event</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
<p>SignalRegistry which will be used to bind signals that need to be called on game engine event; other ubiquitousse modules may bind to this registry
|
||||
<p><a href="../modules/signal.html#SignalRegistry_objects">SignalRegistry</a> which will be used to bind signals that need to be called on game engine event; other ubiquitousse modules may bind to this registry
|
||||
if avaible. </p>
|
||||
|
||||
<p> For example, every ubiquitousse module with a “update” function will bind it to the “update” signal in the registry;
|
||||
|
|
@ -166,6 +172,9 @@
|
|||
|
||||
|
||||
</ul>
|
||||
<h3>Type:</h3>
|
||||
<ul>
|
||||
<code>SignalRegistry</code>
|
||||
</ul>
|
||||
</ul>
|
||||
</ul>
|
||||
|
|
@ -215,6 +224,9 @@
|
|||
Map of signals to list of listeners.
|
||||
|
||||
</ul>
|
||||
<h3>Type:</h3>
|
||||
<ul>
|
||||
<code>{["name"]={fn,...}}</code>
|
||||
</ul>
|
||||
</ul>
|
||||
</ul>
|
||||
|
|
@ -240,16 +252,16 @@
|
|||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">name</span>
|
||||
|
||||
|
||||
<span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
|
||||
the name of the signal
|
||||
</li>
|
||||
<li><span class="parameter">fn</span>
|
||||
|
||||
|
||||
<span class="types"><span class="type">function</span></span>
|
||||
the function to bind to the signal
|
||||
</li>
|
||||
<li><span class="parameter">...</span>
|
||||
|
||||
|
||||
<span class="types"><span class="type">function,...</span></span>
|
||||
other function to bind to the signal
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
|
@ -273,16 +285,16 @@
|
|||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">name</span>
|
||||
|
||||
|
||||
<span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
|
||||
the name of the signal
|
||||
</li>
|
||||
<li><span class="parameter">fn</span>
|
||||
|
||||
|
||||
<span class="types"><span class="type">function</span></span>
|
||||
the function to unbind to the signal
|
||||
</li>
|
||||
<li><span class="parameter">...</span>
|
||||
|
||||
|
||||
<span class="types"><span class="type">function,...</span></span>
|
||||
other function to unbind to the signal
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
|
@ -306,8 +318,8 @@
|
|||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">name</span>
|
||||
|
||||
|
||||
<span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
|
||||
the name of the signal
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
|
@ -331,16 +343,16 @@
|
|||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">name</span>
|
||||
|
||||
|
||||
<span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
|
||||
the name of the signal
|
||||
</li>
|
||||
<li><span class="parameter">sourceFn</span>
|
||||
|
||||
|
||||
<span class="types"><span class="type">function</span></span>
|
||||
the function currently bound to the signal
|
||||
</li>
|
||||
<li><span class="parameter">destFn</span>
|
||||
|
||||
|
||||
<span class="types"><span class="type">function</span></span>
|
||||
the function that will replace the previous one
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
|
@ -382,12 +394,11 @@
|
|||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">name</span>
|
||||
|
||||
|
||||
<span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
|
||||
the name of the signal
|
||||
</li>
|
||||
<li><span class="parameter">...</span>
|
||||
|
||||
|
||||
arguments to pass to the functions bound to this signal
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
|
@ -403,7 +414,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 2021-12-25 23:19:42 </i>
|
||||
<i style="float:right;">Last updated 2021-12-26 18:13:01 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
|
|
|
|||
|
|
@ -62,8 +62,13 @@
|
|||
<div id="content">
|
||||
|
||||
<h1>Module <code>timer</code></h1>
|
||||
<p>Time related functions.</p>
|
||||
<p>Timer management for Lua.</p>
|
||||
<p> No dependency.</p>
|
||||
<h3>Usage:</h3>
|
||||
<ul>
|
||||
<pre class="example">TODO
|
||||
</pre>
|
||||
</ul>
|
||||
|
||||
|
||||
<h2><a href="#Module">Module </a></h2>
|
||||
|
|
@ -84,19 +89,19 @@
|
|||
<h2><a href="#Timer_objects">Timer objects </a></h2>
|
||||
<table class="function_list">
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#Timer:after">Timer:after (time)</a></td>
|
||||
<td class="name" nowrap><a href="#Timer:after">Timer:after ([, time])</a></td>
|
||||
<td class="summary">Wait time seconds before running the function.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#Timer:every">Timer:every (time)</a></td>
|
||||
<td class="name" nowrap><a href="#Timer:every">Timer:every ([, time])</a></td>
|
||||
<td class="summary">Run the function every time millisecond.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#Timer:times">Timer:times (count)</a></td>
|
||||
<td class="name" nowrap><a href="#Timer:times">Timer:times ([, count])</a></td>
|
||||
<td class="summary">The function will not execute more than count times.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#Timer:during">Timer:during (time)</a></td>
|
||||
<td class="name" nowrap><a href="#Timer:during">Timer:during ([, time])</a></td>
|
||||
<td class="summary">The timer will be active for a time duration.</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
|
@ -193,7 +198,7 @@
|
|||
<h2><a href="#TweenTimer_objects">TweenTimer objects </a></h2>
|
||||
<table class="function_list">
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#r.chain">r.chain (_, duration_, tbl_, to_, method_)</a></td>
|
||||
<td class="name" nowrap><a href="#r:chain">r:chain (duration, tbl, to[, method="linear"])</a></td>
|
||||
<td class="summary">Creates another tween which will be initialized when the current one ends.</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
|
@ -264,7 +269,7 @@
|
|||
<ol>
|
||||
|
||||
<span class="types"><a class="type" href="../modules/timer.html#Timer_objects">Timer</a></span>
|
||||
the object
|
||||
the new timer
|
||||
</ol>
|
||||
|
||||
|
||||
|
|
@ -326,7 +331,7 @@
|
|||
<dl class="function">
|
||||
<dt>
|
||||
<a name = "Timer:after"></a>
|
||||
<strong>Timer:after (time)</strong>
|
||||
<strong>Timer:after ([, time])</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Wait time seconds before running the function.
|
||||
|
|
@ -340,11 +345,18 @@
|
|||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">time</span>
|
||||
|
||||
|
||||
<span class="types"><span class="type">number</span></span>
|
||||
duration to wait
|
||||
(<em>optional</em>)
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
|
||||
<span class="types"><a class="type" href="../modules/timer.html#Timer_objects">Timer</a></span>
|
||||
the same timer, for chaining method calls
|
||||
</ol>
|
||||
|
||||
|
||||
|
||||
|
|
@ -352,7 +364,7 @@
|
|||
</dd>
|
||||
<dt>
|
||||
<a name = "Timer:every"></a>
|
||||
<strong>Timer:every (time)</strong>
|
||||
<strong>Timer:every ([, time])</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Run the function every time millisecond.
|
||||
|
|
@ -366,11 +378,18 @@
|
|||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">time</span>
|
||||
|
||||
|
||||
<span class="types"><span class="type">number</span></span>
|
||||
duration between execution
|
||||
(<em>optional</em>)
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
|
||||
<span class="types"><a class="type" href="../modules/timer.html#Timer_objects">Timer</a></span>
|
||||
the same timer, for chaining method calls
|
||||
</ol>
|
||||
|
||||
|
||||
|
||||
|
|
@ -378,7 +397,7 @@
|
|||
</dd>
|
||||
<dt>
|
||||
<a name = "Timer:times"></a>
|
||||
<strong>Timer:times (count)</strong>
|
||||
<strong>Timer:times ([, count])</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
The function will not execute more than count times.
|
||||
|
|
@ -392,11 +411,18 @@
|
|||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">count</span>
|
||||
|
||||
|
||||
<span class="types"><span class="type">number</span></span>
|
||||
number of times
|
||||
(<em>optional</em>)
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
|
||||
<span class="types"><a class="type" href="../modules/timer.html#Timer_objects">Timer</a></span>
|
||||
the same timer, for chaining method calls
|
||||
</ol>
|
||||
|
||||
|
||||
|
||||
|
|
@ -404,7 +430,7 @@
|
|||
</dd>
|
||||
<dt>
|
||||
<a name = "Timer:during"></a>
|
||||
<strong>Timer:during (time)</strong>
|
||||
<strong>Timer:during ([, time])</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
The timer will be active for a time duration.
|
||||
|
|
@ -418,11 +444,18 @@
|
|||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">time</span>
|
||||
|
||||
|
||||
<span class="types"><span class="type">number</span></span>
|
||||
duration of execution
|
||||
(<em>optional</em>)
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
|
||||
<span class="types"><a class="type" href="../modules/timer.html#Timer_objects">Timer</a></span>
|
||||
the same timer, for chaining method calls
|
||||
</ol>
|
||||
|
||||
|
||||
|
||||
|
|
@ -464,11 +497,17 @@
|
|||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">func</span>
|
||||
|
||||
|
||||
<span class="types"><span class="type">function</span></span>
|
||||
function that returns true if condition is verified
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
|
||||
<span class="types"><a class="type" href="../modules/timer.html#Timer_objects">Timer</a></span>
|
||||
the same timer, for chaining method calls
|
||||
</ol>
|
||||
|
||||
|
||||
|
||||
|
|
@ -490,11 +529,17 @@
|
|||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">func</span>
|
||||
|
||||
|
||||
<span class="types"><span class="type">function</span></span>
|
||||
function that returns true if condition is verified
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
|
||||
<span class="types"><a class="type" href="../modules/timer.html#Timer_objects">Timer</a></span>
|
||||
the same timer, for chaining method calls
|
||||
</ol>
|
||||
|
||||
|
||||
|
||||
|
|
@ -517,11 +562,17 @@
|
|||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">func</span>
|
||||
|
||||
|
||||
<span class="types"><span class="type">function</span></span>
|
||||
function that returns true if condition is verified
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
|
||||
<span class="types"><a class="type" href="../modules/timer.html#Timer_objects">Timer</a></span>
|
||||
the same timer, for chaining method calls
|
||||
</ol>
|
||||
|
||||
|
||||
|
||||
|
|
@ -543,11 +594,17 @@
|
|||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">func</span>
|
||||
|
||||
|
||||
<span class="types"><span class="type">function</span></span>
|
||||
function that returns true if condition is verified
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
|
||||
<span class="types"><a class="type" href="../modules/timer.html#Timer_objects">Timer</a></span>
|
||||
the same timer, for chaining method calls
|
||||
</ol>
|
||||
|
||||
|
||||
|
||||
|
|
@ -585,6 +642,12 @@
|
|||
</ul>
|
||||
|
||||
|
||||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
|
||||
<span class="types"><a class="type" href="../modules/timer.html#Timer_objects">Timer</a></span>
|
||||
the same timer, for chaining method calls
|
||||
</ol>
|
||||
|
||||
|
||||
|
||||
|
|
@ -603,6 +666,12 @@
|
|||
</ul>
|
||||
|
||||
|
||||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
|
||||
<span class="types"><a class="type" href="../modules/timer.html#Timer_objects">Timer</a></span>
|
||||
the same timer, for chaining method calls
|
||||
</ol>
|
||||
|
||||
|
||||
|
||||
|
|
@ -621,6 +690,12 @@
|
|||
</ul>
|
||||
|
||||
|
||||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
|
||||
<span class="types"><a class="type" href="../modules/timer.html#Timer_objects">Timer</a></span>
|
||||
the same timer, for chaining method calls
|
||||
</ol>
|
||||
|
||||
|
||||
|
||||
|
|
@ -641,11 +716,17 @@
|
|||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">time</span>
|
||||
|
||||
|
||||
<span class="types"><span class="type">number</span></span>
|
||||
duration to skip
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
|
||||
<span class="types"><a class="type" href="../modules/timer.html#Timer_objects">Timer</a></span>
|
||||
the same timer, for chaining method calls
|
||||
</ol>
|
||||
|
||||
|
||||
|
||||
|
|
@ -685,11 +766,17 @@
|
|||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">func</span>
|
||||
|
||||
|
||||
<span class="types"><span class="type">function</span></span>
|
||||
function to call when timer start
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
|
||||
<span class="types"><a class="type" href="../modules/timer.html#Timer_objects">Timer</a></span>
|
||||
the same timer, for chaining method calls
|
||||
</ol>
|
||||
|
||||
|
||||
|
||||
|
|
@ -710,11 +797,17 @@
|
|||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">func</span>
|
||||
|
||||
|
||||
<span class="types"><span class="type">function</span></span>
|
||||
function to call at each timer update
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
|
||||
<span class="types"><a class="type" href="../modules/timer.html#Timer_objects">Timer</a></span>
|
||||
the same timer, for chaining method calls
|
||||
</ol>
|
||||
|
||||
|
||||
|
||||
|
|
@ -735,11 +828,17 @@
|
|||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">func</span>
|
||||
|
||||
|
||||
<span class="types"><span class="type">function</span></span>
|
||||
function to call when timer ends
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
|
||||
<span class="types"><a class="type" href="../modules/timer.html#Timer_objects">Timer</a></span>
|
||||
the same timer, for chaining method calls
|
||||
</ol>
|
||||
|
||||
|
||||
|
||||
|
|
@ -780,8 +879,8 @@
|
|||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">func</span>
|
||||
|
||||
|
||||
<span class="types"><span class="type">function</span></span>
|
||||
function called by the chained timer
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
|
@ -789,8 +888,7 @@
|
|||
<ol>
|
||||
|
||||
<span class="types"><a class="type" href="../modules/timer.html#Timer_objects">Timer</a></span>
|
||||
|
||||
|
||||
the new timer
|
||||
</ol>
|
||||
|
||||
|
||||
|
|
@ -917,11 +1015,17 @@
|
|||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">func</span>
|
||||
|
||||
|
||||
<span class="types"><span class="type">function</span></span>
|
||||
function called by the timer
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
|
||||
<span class="types"><a class="type" href="../modules/timer.html#Timer_objects">Timer</a></span>
|
||||
the new timer
|
||||
</ol>
|
||||
|
||||
|
||||
|
||||
|
|
@ -960,6 +1064,12 @@
|
|||
</li>
|
||||
</ul>
|
||||
|
||||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
|
||||
<span class="types"><a class="type" href="../modules/timer.html#TweenTimer_objects">TweenTimer</a></span>
|
||||
the new timer
|
||||
</ol>
|
||||
|
||||
|
||||
|
||||
|
|
@ -991,13 +1101,13 @@
|
|||
</div>
|
||||
<dl class="function">
|
||||
<dt>
|
||||
<a name = "r.chain"></a>
|
||||
<strong>r.chain (_, duration_, tbl_, to_, method_)</strong>
|
||||
<a name = "r:chain"></a>
|
||||
<strong>r:chain (duration, tbl, to[, method="linear"])</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Creates another tween which will be initialized when the current one ends.
|
||||
If tbl<em> and/or method</em> are not specified, the values from the current tween will be used.
|
||||
Returns the new tween.
|
||||
Returns the new tween timer.
|
||||
|
||||
</ul>
|
||||
</ul>
|
||||
|
|
@ -1006,25 +1116,22 @@
|
|||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">_</span>
|
||||
|
||||
|
||||
<li><span class="parameter">duration</span>
|
||||
<span class="types"><span class="type">number</span></span>
|
||||
tween duration (seconds)
|
||||
</li>
|
||||
<li><span class="parameter">duration_</span>
|
||||
|
||||
|
||||
<li><span class="parameter">tbl</span>
|
||||
<span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.5">table</a></span>
|
||||
the table containing the values to tween
|
||||
</li>
|
||||
<li><span class="parameter">tbl_</span>
|
||||
|
||||
|
||||
<li><span class="parameter">to</span>
|
||||
<span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.5">table</a></span>
|
||||
the new values
|
||||
</li>
|
||||
<li><span class="parameter">to_</span>
|
||||
|
||||
|
||||
</li>
|
||||
<li><span class="parameter">method_</span>
|
||||
|
||||
|
||||
<li><span class="parameter">method</span>
|
||||
<span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.4">string/function</a></span>
|
||||
tweening method (string name or the actual function(time, start, change, duration))
|
||||
(<em>default</em> "linear")
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
|
@ -1032,8 +1139,7 @@
|
|||
<ol>
|
||||
|
||||
<span class="types"><a class="type" href="../modules/timer.html#TweenTimer_objects">TweenTimer</a></span>
|
||||
|
||||
|
||||
the new timer
|
||||
</ol>
|
||||
|
||||
|
||||
|
|
@ -1047,7 +1153,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 2021-12-25 23:19:42 </i>
|
||||
<i style="float:right;">Last updated 2021-12-26 18:13:01 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
|
|
|
|||
|
|
@ -103,12 +103,9 @@
|
|||
</ul>
|
||||
|
||||
|
||||
<p> Regarding the documentation: Ubiquitousse used LDoc/LuaDoc styled-comments, but since LDoc hates me and my code, the
|
||||
generated result is complete garbage, so please read the documentation directly in the comments here until fix this.
|
||||
Stuff you're interested in starts with triple – (e.g., “—– This functions saves the world”).</p>
|
||||
|
||||
<p> <em>UPDATE</em>: I give up, currently in the process of admitting defat to LDoc and progressively porting all my documentation to it.
|
||||
Though I had to modify a few things to get LDoc to like me, so the documentation is generated using <a href="https://github.com/Reuh/LDoc">my LDoc fork</a>.</p>
|
||||
<p> Regarding the documentation: Ubiquitousse uses LDoc/LuaDoc styled-comments, but since LDoc hates me and my code, the
|
||||
generated result is mostly garbage, so to generate the documentation you will need to use my <a href="https://github.com/Reuh/LDoc">LDoc fork</a>
|
||||
which I modified to force LDoc to like me.</p>
|
||||
<h3>Usage:</h3>
|
||||
<ul>
|
||||
<pre class="example">local ubiquitousse = require("ubiquitousse")
|
||||
|
|
@ -364,7 +361,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 2021-12-25 23:19:42 </i>
|
||||
<i style="float:right;">Last updated 2021-12-26 18:13:01 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
|
|
|
|||
|
|
@ -59,8 +59,13 @@
|
|||
<div id="content">
|
||||
|
||||
<h1>Module <code>util</code></h1>
|
||||
<p>Various functions useful for game developement.</p>
|
||||
<p>Various functions useful for Lua game developement.</p>
|
||||
<p> No dependency.</p>
|
||||
<h3>Usage:</h3>
|
||||
<ul>
|
||||
<pre class="example">TODO
|
||||
</pre>
|
||||
</ul>
|
||||
|
||||
|
||||
<h2><a href="#Functions">Functions </a></h2>
|
||||
|
|
@ -779,7 +784,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 2021-12-25 23:19:42 </i>
|
||||
<i style="float:right;">Last updated 2021-12-26 18:13:01 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
|
|
|
|||
|
|
@ -64,7 +64,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 2021-12-25 23:19:42 </i>
|
||||
<i style="float:right;">Last updated 2021-12-26 18:13:01 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
|
|
|
|||
|
|
@ -58,7 +58,9 @@
|
|||
|
||||
<p>Set of various libraries I use for game development, mainly with LÖVE. Nothing that hasn’t been done before, but these are tailored to what I need. They can be used independently too.</p>
|
||||
|
||||
<p>Documentation is done in LDoc-like comments in source files, but LDoc doesn’t really like how I structure my libraries so you can’t really generate documentation with it. I'm currently trying to fix this; some modules already have a working LDoc documentation that you can read <a href="https://reuh.github.io/ubiquitousse/index.html">here</a> or in the <code>docs/</code> directory.</p>
|
||||
<p>You can find the documentation <a href="https://reuh.github.io/ubiquitousse/index.html">here</a> or in the <code>docs/</code> directory.</p>
|
||||
|
||||
<p>Documentation is done in LDoc-like comments in source files, but LDoc doesn’t really like how I structure my libraries (and the fact I use <a href="https://github.com/Reuh/candran">Candran</a>) so you will need my <a href="https://github.com/Reuh/LDoc">LDoc fork</a> if you want to generate the documentation yourself.</p>
|
||||
|
||||
<p>Whatever is currently on the master branch should be working and usable. Changelog, including breaking changes, are documented in commit messages.</p>
|
||||
|
||||
|
|
@ -69,7 +71,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 2021-12-25 23:19:42 </i>
|
||||
<i style="float:right;">Last updated 2021-12-26 18:13:01 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue