mirror of
https://github.com/Reuh/ubiquitousse.git
synced 2025-10-27 17:19:31 +00:00
369 lines
8.3 KiB
HTML
369 lines
8.3 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
|
|
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
|
|
<html>
|
|
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
|
|
<head>
|
|
<title>Ubiquitousse reference</title>
|
|
<link rel="stylesheet" href="../ldoc_new.css" type="text/css" />
|
|
</head>
|
|
<body>
|
|
|
|
<div id="container">
|
|
|
|
<div id="product">
|
|
<div id="product_logo"></div>
|
|
<div id="product_name"><big><b></b></big></div>
|
|
<div id="product_description"></div>
|
|
</div> <!-- id="product" -->
|
|
|
|
|
|
<div id="main">
|
|
|
|
|
|
<!-- Menu -->
|
|
|
|
<div id="navigation">
|
|
<br/>
|
|
<h1>Ubiquitousse</h1>
|
|
|
|
|
|
<ul>
|
|
<li><a href="../index.html">Index</a></li>
|
|
</ul>
|
|
|
|
<h2>Contents</h2>
|
|
<ul>
|
|
<li><a href="#Fields">Fields</a></li>
|
|
</ul>
|
|
|
|
|
|
<h2>Modules</h2>
|
|
<ul class="nowrap">
|
|
<li><strong>ubiquitousse</strong></li>
|
|
<li><a href="../modules/asset.html">asset</a></li>
|
|
<li><a href="../modules/ecs.html">ecs</a></li>
|
|
<li><a href="../modules/ldtk.html">ldtk</a></li>
|
|
<li><a href="../modules/scene.html">scene</a></li>
|
|
<li><a href="../modules/signal.html">signal</a></li>
|
|
<li><a href="../modules/timer.html">timer</a></li>
|
|
<li><a href="../modules/util.html">util</a></li>
|
|
</ul>
|
|
<h2>Topics</h2>
|
|
<ul class="">
|
|
<li><a href="../topics/README.md.html">README</a></li>
|
|
<li><a href="../topics/LICENSE.html">LICENSE</a></li>
|
|
</ul>
|
|
|
|
</div>
|
|
|
|
<div id="content">
|
|
|
|
<h1>Module <code>ubiquitousse</code></h1>
|
|
<p>Ubiquitousse main module.</p>
|
|
<p> Set of various Lua libraries to make game development easier, mainly made to be used alongside the <a href="https://love2d.org/">LÖVE</a> game framework.
|
|
Nothing that hasn’t been done before, but these are tailored to what I need. They can be used independently too, and are relatively portable, even without LÖVE.</p>
|
|
|
|
<p> This is the main module, which will try to load every other Ubiquitousse module when required and may even provide a few convenience functions.</p>
|
|
|
|
<p> This also perform a quick LÖVE version check and show a warning in case of potential incompatibility.</p>
|
|
|
|
<p> <strong>Regarding Ubiquitousse’s organization</strong></p>
|
|
|
|
<p> Ubiquitousse may or may not be used in its totality. You can delete the modules directories you don’t need and Ubiquitousse
|
|
should adapt accordingly. You can also simply copy the modules directories you need and use them directly, without using this
|
|
file at all.
|
|
However, some modules may provide more feature when other modules are available.
|
|
These dependencies are written at the top of every main module file.</p>
|
|
|
|
<p> Ubiquitousse’s original goal was to run everywhere with the least porting effort possible, so while the current version now mainly focus LÖVE, it
|
|
should still be easily modifiable to work with something else. Ubiquitousse is mainly tested on LuaJIT and Lua 5.3 but should also support Lua 5.1 and 5.2.
|
|
In order to keep a good idea of how portable this all is, other dependencies, including LÖVE, are explicited at the top of every module file and in specific
|
|
functions definition using the <code>@require</code> tag (e.g., <code>— @require love</code> for LÖVE).</p>
|
|
|
|
<p> Some modules are developped in <a href="https://github.com/Reuh/candran">Candran</a> (.can files), but can easily be compiled into regular Lua code.</p>
|
|
|
|
<p> Units used in the API documentation, unless written otherwise:</p>
|
|
|
|
<ul>
|
|
<li>All distances are expressed in pixels (px)</li>
|
|
<li>All durations are expressed in seconds (s)</li>
|
|
</ul>
|
|
|
|
|
|
<p> These units are only used to make writing documentation easier; you can use other units if you want, as long as you're consistent.</p>
|
|
|
|
<p> Style:</p>
|
|
|
|
<ul>
|
|
<li>tabs for indentation, spaces for esthetic whitespace (notably in comments)</li>
|
|
<li>no globals</li>
|
|
<li>UPPERCASE for constants (or maybe not).</li>
|
|
<li>CamelCase for class names.</li>
|
|
<li>lowerCamelCase is expected for everything else.</li>
|
|
</ul>
|
|
|
|
|
|
<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")
|
|
</pre>
|
|
</ul>
|
|
|
|
|
|
<h2><a href="#Fields">Fields</a></h2>
|
|
<table class="function_list">
|
|
<tr>
|
|
<td class="name" nowrap><a href="#version">version</a></td>
|
|
<td class="summary">Ubiquitousse version string (currently <code>"0.1.0"</code>).</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap><a href="#asset">asset</a></td>
|
|
<td class="summary">Asset manager module, if available.</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap><a href="#ecs">ecs</a></td>
|
|
<td class="summary">Entity Component System, if available.</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap><a href="#input">input</a></td>
|
|
<td class="summary">Input management, if available.</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap><a href="#ldtk">ldtk</a></td>
|
|
<td class="summary">LDtk level import, if available.</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap><a href="#scene">scene</a></td>
|
|
<td class="summary">Scene management, if available.</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap><a href="#signal">signal</a></td>
|
|
<td class="summary">Signal management, if available.</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap><a href="#timer">timer</a></td>
|
|
<td class="summary">Timer utilities, if available.</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap><a href="#util">util</a></td>
|
|
<td class="summary">Various useful functions, if available.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br/>
|
|
<br/>
|
|
|
|
|
|
<h2 class="section-header "><a name="Fields"></a>Fields</h2>
|
|
|
|
<dl class="function">
|
|
<dt>
|
|
<a name = "version"></a>
|
|
<strong>version</strong>
|
|
</dt>
|
|
<dd>
|
|
Ubiquitousse version string (currently <code>"0.1.0"</code>).
|
|
|
|
</ul>
|
|
</ul>
|
|
</ul>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</dd>
|
|
<dt>
|
|
<a name = "asset"></a>
|
|
<strong>asset</strong>
|
|
</dt>
|
|
<dd>
|
|
Asset manager module, if available.
|
|
|
|
</ul>
|
|
</ul>
|
|
</ul>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
<h3>See also:</h3>
|
|
<ul>
|
|
<a href="../modules/asset.html#">asset</a>
|
|
</ul>
|
|
|
|
|
|
</dd>
|
|
<dt>
|
|
<a name = "ecs"></a>
|
|
<strong>ecs</strong>
|
|
</dt>
|
|
<dd>
|
|
Entity Component System, if available.
|
|
|
|
</ul>
|
|
</ul>
|
|
</ul>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
<h3>See also:</h3>
|
|
<ul>
|
|
<a href="../modules/ecs.html#">ecs</a>
|
|
</ul>
|
|
|
|
|
|
</dd>
|
|
<dt>
|
|
<a name = "input"></a>
|
|
<strong>input</strong>
|
|
</dt>
|
|
<dd>
|
|
Input management, if available.
|
|
TODO: not currently generated with LDoc.
|
|
|
|
</ul>
|
|
</ul>
|
|
</ul>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
<h3>See also:</h3>
|
|
<ul>
|
|
<a href="../modules/ubiquitousse.html#input">input</a>
|
|
</ul>
|
|
|
|
|
|
</dd>
|
|
<dt>
|
|
<a name = "ldtk"></a>
|
|
<strong>ldtk</strong>
|
|
</dt>
|
|
<dd>
|
|
LDtk level import, if available.
|
|
|
|
</ul>
|
|
</ul>
|
|
</ul>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
<h3>See also:</h3>
|
|
<ul>
|
|
<a href="../modules/ldtk.html#">ldtk</a>
|
|
</ul>
|
|
|
|
|
|
</dd>
|
|
<dt>
|
|
<a name = "scene"></a>
|
|
<strong>scene</strong>
|
|
</dt>
|
|
<dd>
|
|
Scene management, if available.
|
|
|
|
</ul>
|
|
</ul>
|
|
</ul>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
<h3>See also:</h3>
|
|
<ul>
|
|
<a href="../modules/scene.html#">scene</a>
|
|
</ul>
|
|
|
|
|
|
</dd>
|
|
<dt>
|
|
<a name = "signal"></a>
|
|
<strong>signal</strong>
|
|
</dt>
|
|
<dd>
|
|
Signal management, if available.
|
|
|
|
</ul>
|
|
</ul>
|
|
</ul>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
<h3>See also:</h3>
|
|
<ul>
|
|
<a href="../modules/signal.html#">signal</a>
|
|
</ul>
|
|
|
|
|
|
</dd>
|
|
<dt>
|
|
<a name = "timer"></a>
|
|
<strong>timer</strong>
|
|
</dt>
|
|
<dd>
|
|
Timer utilities, if available.
|
|
|
|
</ul>
|
|
</ul>
|
|
</ul>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
<h3>See also:</h3>
|
|
<ul>
|
|
<a href="../modules/timer.html#">timer</a>
|
|
</ul>
|
|
|
|
|
|
</dd>
|
|
<dt>
|
|
<a name = "util"></a>
|
|
<strong>util</strong>
|
|
</dt>
|
|
<dd>
|
|
Various useful functions, if available.
|
|
|
|
</ul>
|
|
</ul>
|
|
</ul>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
<h3>See also:</h3>
|
|
<ul>
|
|
<a href="../modules/util.html#">util</a>
|
|
</ul>
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
</div> <!-- id="content" -->
|
|
</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-27 13:15:05 </i>
|
|
</div> <!-- id="about" -->
|
|
</div> <!-- id="container" -->
|
|
</body>
|
|
</html>
|