mirror of
https://github.com/Reuh/ubiquitousse.git
synced 2025-10-27 09:09:30 +00:00
Update doc
This commit is contained in:
parent
7e0c41bb04
commit
bfa73f6dd0
11 changed files with 31 additions and 31 deletions
|
|
@ -108,7 +108,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 2021-12-27 14:09:51 </i>
|
<i style="float:right;">Last updated 2021-12-27 16:25:25 </i>
|
||||||
</div> <!-- id="about" -->
|
</div> <!-- id="about" -->
|
||||||
</div> <!-- id="container" -->
|
</div> <!-- id="container" -->
|
||||||
</body>
|
</body>
|
||||||
|
|
|
||||||
|
|
@ -334,7 +334,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 2021-12-27 14:09:51 </i>
|
<i style="float:right;">Last updated 2021-12-27 16:25:25 </i>
|
||||||
</div> <!-- id="about" -->
|
</div> <!-- id="about" -->
|
||||||
</div> <!-- id="container" -->
|
</div> <!-- id="container" -->
|
||||||
</body>
|
</body>
|
||||||
|
|
|
||||||
|
|
@ -1683,7 +1683,7 @@ its sibling systems (i.e. completely stop the propagation of the event).</li>
|
||||||
</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 2021-12-27 14:09:51 </i>
|
<i style="float:right;">Last updated 2021-12-27 16:25:25 </i>
|
||||||
</div> <!-- id="about" -->
|
</div> <!-- id="about" -->
|
||||||
</div> <!-- id="container" -->
|
</div> <!-- id="container" -->
|
||||||
</body>
|
</body>
|
||||||
|
|
|
||||||
|
|
@ -178,7 +178,7 @@ end
|
||||||
<h2><a href="#Layer_objects">Layer objects </a></h2>
|
<h2><a href="#Layer_objects">Layer objects </a></h2>
|
||||||
<table class="function_list">
|
<table class="function_list">
|
||||||
<tr>
|
<tr>
|
||||||
<td class="name" nowrap><a href="#Layer:draw">Layer:draw ([, x=0[, y=0]])</a></td>
|
<td class="name" nowrap><a href="#Layer:draw">Layer:draw ([x=0[, y=0]])</a></td>
|
||||||
<td class="summary">Draw the current layer.</td>
|
<td class="summary">Draw the current layer.</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
|
|
@ -311,19 +311,19 @@ end
|
||||||
<h2><a href="#Level_objects">Level objects </a></h2>
|
<h2><a href="#Level_objects">Level objects </a></h2>
|
||||||
<table class="function_list">
|
<table class="function_list">
|
||||||
<tr>
|
<tr>
|
||||||
<td class="name" nowrap><a href="#Level:draw">Level:draw ([, x=0[, y=0]])</a></td>
|
<td class="name" nowrap><a href="#Level:draw">Level:draw ([x=0[, y=0]])</a></td>
|
||||||
<td class="summary">Draw this level.</td>
|
<td class="summary">Draw this level.</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td class="name" nowrap><a href="#Level:drawBackground">Level:drawBackground ([, x=0[, y=0]])</a></td>
|
<td class="name" nowrap><a href="#Level:drawBackground">Level:drawBackground ([x=0[, y=0]])</a></td>
|
||||||
<td class="summary">Draw this level background.</td>
|
<td class="summary">Draw this level background.</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td class="name" nowrap><a href="#Level:load">Level:load ([, callbacks])</a></td>
|
<td class="name" nowrap><a href="#Level:load">Level:load ([callbacks])</a></td>
|
||||||
<td class="summary">Load the level.</td>
|
<td class="summary">Load the level.</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td class="name" nowrap><a href="#Level:unload">Level:unload ([, callbacks])</a></td>
|
<td class="name" nowrap><a href="#Level:unload">Level:unload ([callbacks])</a></td>
|
||||||
<td class="summary">Unload the level.</td>
|
<td class="summary">Unload the level.</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
|
|
@ -767,7 +767,7 @@ end
|
||||||
<dl class="function">
|
<dl class="function">
|
||||||
<dt>
|
<dt>
|
||||||
<a name = "Layer:draw"></a>
|
<a name = "Layer:draw"></a>
|
||||||
<strong>Layer:draw ([, x=0[, y=0]])</strong>
|
<strong>Layer:draw ([x=0[, y=0]])</strong>
|
||||||
</dt>
|
</dt>
|
||||||
<dd>
|
<dd>
|
||||||
Draw the current layer. </p>
|
Draw the current layer. </p>
|
||||||
|
|
@ -1475,7 +1475,7 @@ end
|
||||||
<dl class="function">
|
<dl class="function">
|
||||||
<dt>
|
<dt>
|
||||||
<a name = "Level:draw"></a>
|
<a name = "Level:draw"></a>
|
||||||
<strong>Level:draw ([, x=0[, y=0]])</strong>
|
<strong>Level:draw ([x=0[, y=0]])</strong>
|
||||||
</dt>
|
</dt>
|
||||||
<dd>
|
<dd>
|
||||||
Draw this level.
|
Draw this level.
|
||||||
|
|
@ -1515,7 +1515,7 @@ end
|
||||||
</dd>
|
</dd>
|
||||||
<dt>
|
<dt>
|
||||||
<a name = "Level:drawBackground"></a>
|
<a name = "Level:drawBackground"></a>
|
||||||
<strong>Level:drawBackground ([, x=0[, y=0]])</strong>
|
<strong>Level:drawBackground ([x=0[, y=0]])</strong>
|
||||||
</dt>
|
</dt>
|
||||||
<dd>
|
<dd>
|
||||||
Draw this level background. </p>
|
Draw this level background. </p>
|
||||||
|
|
@ -1554,7 +1554,7 @@ end
|
||||||
</dd>
|
</dd>
|
||||||
<dt>
|
<dt>
|
||||||
<a name = "Level:load"></a>
|
<a name = "Level:load"></a>
|
||||||
<strong>Level:load ([, callbacks])</strong>
|
<strong>Level:load ([callbacks])</strong>
|
||||||
</dt>
|
</dt>
|
||||||
<dd>
|
<dd>
|
||||||
Load the level.
|
Load the level.
|
||||||
|
|
@ -1595,7 +1595,7 @@ end
|
||||||
</dd>
|
</dd>
|
||||||
<dt>
|
<dt>
|
||||||
<a name = "Level:unload"></a>
|
<a name = "Level:unload"></a>
|
||||||
<strong>Level:unload ([, callbacks])</strong>
|
<strong>Level:unload ([callbacks])</strong>
|
||||||
</dt>
|
</dt>
|
||||||
<dd>
|
<dd>
|
||||||
<p>Unload the level.
|
<p>Unload the level.
|
||||||
|
|
@ -1829,7 +1829,7 @@ end
|
||||||
Level background. </p>
|
Level background. </p>
|
||||||
|
|
||||||
<p> If there is a background image, <code>background.image</code> contains a table <code>{image=image, x=number, y=number, sx=number, sy=number}</code>
|
<p> If there is a background image, <code>background.image</code> contains a table <code>{image=image, x=number, y=number, sx=number, sy=number}</code>
|
||||||
where <a href="../modules/ldtk.html#Tileset.image">image</a> is the LÖVE image (or image filepath if LÖVE not available) <a href="../modules/ldtk.html#Layer.x">x</a> and <a href="../modules/ldtk.html#Level.y">y</a> are the top-left position,
|
where <a href="../modules/ldtk.html#Tileset.image">image</a> is the LÖVE image (or image filepath if LÖVE not available) <a href="../modules/ldtk.html#Tile.x">x</a> and <a href="../modules/ldtk.html#Entity.y">y</a> are the top-left position,
|
||||||
and <a href="../modules/ldtk.html#Entity.sx">sx</a> and <a href="../modules/ldtk.html#Entity.sy">sy</a> the horizontal and vertical scale factors.
|
and <a href="../modules/ldtk.html#Entity.sx">sx</a> and <a href="../modules/ldtk.html#Entity.sy">sy</a> the horizontal and vertical scale factors.
|
||||||
|
|
||||||
</ul>
|
</ul>
|
||||||
|
|
@ -1904,7 +1904,7 @@ end
|
||||||
<li>Enum are converted into a Lua string giving the currently selected enum value.</li>
|
<li>Enum are converted into a Lua string giving the currently selected enum value.</li>
|
||||||
<li>Filepath are converted into a Lua string giving the file path.</li>
|
<li>Filepath are converted into a Lua string giving the file path.</li>
|
||||||
<li>Arrays are converted into a Lua table with the elements in it as a list.</li>
|
<li>Arrays are converted into a Lua table with the elements in it as a list.</li>
|
||||||
<li>Points are converted into a Lua table with the fields <a href="../modules/ldtk.html#Layer.x">x</a> and <a href="../modules/ldtk.html#Level.y">y</a>: <code>{ x=number, y=number }</code>.</li>
|
<li>Points are converted into a Lua table with the fields <a href="../modules/ldtk.html#Tile.x">x</a> and <a href="../modules/ldtk.html#Entity.y">y</a>: <code>{ x=number, y=number }</code>.</li>
|
||||||
<li>Colors are converted into a Lua table with the red, green and blue components in [0-1] as a list: <code>{r,g,b}</code>.</li>
|
<li>Colors are converted into a Lua table with the red, green and blue components in [0-1] as a list: <code>{r,g,b}</code>.</li>
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
|
|
@ -1930,7 +1930,7 @@ end
|
||||||
</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 2021-12-27 14:09:51 </i>
|
<i style="float:right;">Last updated 2021-12-27 16:25:25 </i>
|
||||||
</div> <!-- id="about" -->
|
</div> <!-- id="about" -->
|
||||||
</div> <!-- id="container" -->
|
</div> <!-- id="container" -->
|
||||||
</body>
|
</body>
|
||||||
|
|
|
||||||
|
|
@ -702,7 +702,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 2021-12-27 14:09:51 </i>
|
<i style="float:right;">Last updated 2021-12-27 16:25:25 </i>
|
||||||
</div> <!-- id="about" -->
|
</div> <!-- id="about" -->
|
||||||
</div> <!-- id="container" -->
|
</div> <!-- id="container" -->
|
||||||
</body>
|
</body>
|
||||||
|
|
|
||||||
|
|
@ -414,7 +414,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 2021-12-27 14:09:51 </i>
|
<i style="float:right;">Last updated 2021-12-27 16:25:25 </i>
|
||||||
</div> <!-- id="about" -->
|
</div> <!-- id="about" -->
|
||||||
</div> <!-- id="container" -->
|
</div> <!-- id="container" -->
|
||||||
</body>
|
</body>
|
||||||
|
|
|
||||||
|
|
@ -89,19 +89,19 @@
|
||||||
<h2><a href="#Timer_objects">Timer objects </a></h2>
|
<h2><a href="#Timer_objects">Timer objects </a></h2>
|
||||||
<table class="function_list">
|
<table class="function_list">
|
||||||
<tr>
|
<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>
|
<td class="summary">Wait time seconds before running the function.</td>
|
||||||
</tr>
|
</tr>
|
||||||
<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>
|
<td class="summary">Run the function every time millisecond.</td>
|
||||||
</tr>
|
</tr>
|
||||||
<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>
|
<td class="summary">The function will not execute more than count times.</td>
|
||||||
</tr>
|
</tr>
|
||||||
<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>
|
<td class="summary">The timer will be active for a time duration.</td>
|
||||||
</tr>
|
</tr>
|
||||||
</table>
|
</table>
|
||||||
|
|
@ -331,7 +331,7 @@
|
||||||
<dl class="function">
|
<dl class="function">
|
||||||
<dt>
|
<dt>
|
||||||
<a name = "Timer:after"></a>
|
<a name = "Timer:after"></a>
|
||||||
<strong>Timer:after ([, time])</strong>
|
<strong>Timer:after ([time])</strong>
|
||||||
</dt>
|
</dt>
|
||||||
<dd>
|
<dd>
|
||||||
Wait time seconds before running the function.
|
Wait time seconds before running the function.
|
||||||
|
|
@ -364,7 +364,7 @@
|
||||||
</dd>
|
</dd>
|
||||||
<dt>
|
<dt>
|
||||||
<a name = "Timer:every"></a>
|
<a name = "Timer:every"></a>
|
||||||
<strong>Timer:every ([, time])</strong>
|
<strong>Timer:every ([time])</strong>
|
||||||
</dt>
|
</dt>
|
||||||
<dd>
|
<dd>
|
||||||
Run the function every time millisecond.
|
Run the function every time millisecond.
|
||||||
|
|
@ -397,7 +397,7 @@
|
||||||
</dd>
|
</dd>
|
||||||
<dt>
|
<dt>
|
||||||
<a name = "Timer:times"></a>
|
<a name = "Timer:times"></a>
|
||||||
<strong>Timer:times ([, count])</strong>
|
<strong>Timer:times ([count])</strong>
|
||||||
</dt>
|
</dt>
|
||||||
<dd>
|
<dd>
|
||||||
The function will not execute more than count times.
|
The function will not execute more than count times.
|
||||||
|
|
@ -430,7 +430,7 @@
|
||||||
</dd>
|
</dd>
|
||||||
<dt>
|
<dt>
|
||||||
<a name = "Timer:during"></a>
|
<a name = "Timer:during"></a>
|
||||||
<strong>Timer:during ([, time])</strong>
|
<strong>Timer:during ([time])</strong>
|
||||||
</dt>
|
</dt>
|
||||||
<dd>
|
<dd>
|
||||||
The timer will be active for a time duration.
|
The timer will be active for a time duration.
|
||||||
|
|
@ -1153,7 +1153,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 2021-12-27 14:09:51 </i>
|
<i style="float:right;">Last updated 2021-12-27 16:25:25 </i>
|
||||||
</div> <!-- id="about" -->
|
</div> <!-- id="about" -->
|
||||||
</div> <!-- id="container" -->
|
</div> <!-- id="container" -->
|
||||||
</body>
|
</body>
|
||||||
|
|
|
||||||
|
|
@ -362,7 +362,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 2021-12-27 14:09:51 </i>
|
<i style="float:right;">Last updated 2021-12-27 16:25:25 </i>
|
||||||
</div> <!-- id="about" -->
|
</div> <!-- id="about" -->
|
||||||
</div> <!-- id="container" -->
|
</div> <!-- id="container" -->
|
||||||
</body>
|
</body>
|
||||||
|
|
|
||||||
|
|
@ -784,7 +784,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 2021-12-27 14:09:51 </i>
|
<i style="float:right;">Last updated 2021-12-27 16:25:25 </i>
|
||||||
</div> <!-- id="about" -->
|
</div> <!-- id="about" -->
|
||||||
</div> <!-- id="container" -->
|
</div> <!-- id="container" -->
|
||||||
</body>
|
</body>
|
||||||
|
|
|
||||||
|
|
@ -64,7 +64,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 2021-12-27 14:09:51 </i>
|
<i style="float:right;">Last updated 2021-12-27 16:25:25 </i>
|
||||||
</div> <!-- id="about" -->
|
</div> <!-- id="about" -->
|
||||||
</div> <!-- id="container" -->
|
</div> <!-- id="container" -->
|
||||||
</body>
|
</body>
|
||||||
|
|
|
||||||
|
|
@ -71,7 +71,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 2021-12-27 14:09:51 </i>
|
<i style="float:right;">Last updated 2021-12-27 16:25:25 </i>
|
||||||
</div> <!-- id="about" -->
|
</div> <!-- id="about" -->
|
||||||
</div> <!-- id="container" -->
|
</div> <!-- id="container" -->
|
||||||
</body>
|
</body>
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue