mirror of
https://github.com/Reuh/ubiquitousse.git
synced 2025-10-27 17:19:31 +00:00
Fix milliseconds remnants in doc
This commit is contained in:
parent
ef413838d4
commit
489d0b4ba7
13 changed files with 26 additions and 25 deletions
|
|
@ -110,7 +110,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-25 20:46:24 </i>
|
<i style="float:right;">Last updated 2021-12-25 23:19:42 </i>
|
||||||
</div> <!-- id="about" -->
|
</div> <!-- id="about" -->
|
||||||
</div> <!-- id="container" -->
|
</div> <!-- id="container" -->
|
||||||
</body>
|
</body>
|
||||||
|
|
|
||||||
|
|
@ -329,7 +329,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-25 20:46:24 </i>
|
<i style="float:right;">Last updated 2021-12-25 23:19:42 </i>
|
||||||
</div> <!-- id="about" -->
|
</div> <!-- id="about" -->
|
||||||
</div> <!-- id="container" -->
|
</div> <!-- id="container" -->
|
||||||
</body>
|
</body>
|
||||||
|
|
|
||||||
|
|
@ -603,7 +603,8 @@
|
||||||
<strong>System.default</strong>
|
<strong>System.default</strong>
|
||||||
</dt>
|
</dt>
|
||||||
<dd>
|
<dd>
|
||||||
Defaults value to put into the entities’s system table when they are added. Will recursively fill missing values.</p>
|
Defaults value to put into the entities’s system table when they are added. Will recursively fill missing values.
|
||||||
|
Metatables will be preserved during the copy but not copied themselves.</p>
|
||||||
|
|
||||||
<p> When an entity is added to a system, a <code>.entity</code> field is always set in the system table, referring to the full entity table.</p>
|
<p> When an entity is added to a system, a <code>.entity</code> field is always set in the system table, referring to the full entity table.</p>
|
||||||
|
|
||||||
|
|
@ -1365,7 +1366,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-25 20:46:24 </i>
|
<i style="float:right;">Last updated 2021-12-25 23:19:42 </i>
|
||||||
</div> <!-- id="about" -->
|
</div> <!-- id="about" -->
|
||||||
</div> <!-- id="container" -->
|
</div> <!-- id="container" -->
|
||||||
</body>
|
</body>
|
||||||
|
|
|
||||||
|
|
@ -1644,7 +1644,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-25 20:46:24 </i>
|
<i style="float:right;">Last updated 2021-12-25 23:19:42 </i>
|
||||||
</div> <!-- id="about" -->
|
</div> <!-- id="about" -->
|
||||||
</div> <!-- id="container" -->
|
</div> <!-- id="container" -->
|
||||||
</body>
|
</body>
|
||||||
|
|
|
||||||
|
|
@ -672,7 +672,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-25 20:46:24 </i>
|
<i style="float:right;">Last updated 2021-12-25 23:19:42 </i>
|
||||||
</div> <!-- id="about" -->
|
</div> <!-- id="about" -->
|
||||||
</div> <!-- id="container" -->
|
</div> <!-- id="container" -->
|
||||||
</body>
|
</body>
|
||||||
|
|
|
||||||
|
|
@ -403,7 +403,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-25 20:46:24 </i>
|
<i style="float:right;">Last updated 2021-12-25 23:19:42 </i>
|
||||||
</div> <!-- id="about" -->
|
</div> <!-- id="about" -->
|
||||||
</div> <!-- id="container" -->
|
</div> <!-- id="container" -->
|
||||||
</body>
|
</body>
|
||||||
|
|
|
||||||
|
|
@ -85,7 +85,7 @@
|
||||||
<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 milliseconds 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>
|
||||||
|
|
@ -242,7 +242,7 @@
|
||||||
The function will receive as first parameter the timer object.
|
The function will receive as first parameter the timer object.
|
||||||
As a second parameter, the function will receive the delta time (dt).
|
As a second parameter, the function will receive the delta time (dt).
|
||||||
As a third parameter, the function will receive the lag time (difference between the time when the function was run and when it should have been run).
|
As a third parameter, the function will receive the lag time (difference between the time when the function was run and when it should have been run).
|
||||||
As a fourth parameter, the function will receive as first parameter the wait(time) function, which will pause the function execution for time miliseconds.
|
As a fourth parameter, the function will receive as first parameter the wait(time) function, which will pause the function execution for time seconds.
|
||||||
You will need to call the :update(dt) method on the timer object every frame to make it do something, or create the timer from a timer registry if you
|
You will need to call the :update(dt) method on the timer object every frame to make it do something, or create the timer from a timer registry if you
|
||||||
don’t want to handle your timers manually.
|
don’t want to handle your timers manually.
|
||||||
|
|
||||||
|
|
@ -289,7 +289,7 @@
|
||||||
<ul>
|
<ul>
|
||||||
<li><span class="parameter">duration</span>
|
<li><span class="parameter">duration</span>
|
||||||
<span class="types"><span class="type">number</span></span>
|
<span class="types"><span class="type">number</span></span>
|
||||||
tween duration (miliseconds)
|
tween duration (seconds)
|
||||||
</li>
|
</li>
|
||||||
<li><span class="parameter">tbl</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>
|
<span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.5">table</a></span>
|
||||||
|
|
@ -329,7 +329,7 @@
|
||||||
<strong>Timer:after (time)</strong>
|
<strong>Timer:after (time)</strong>
|
||||||
</dt>
|
</dt>
|
||||||
<dd>
|
<dd>
|
||||||
Wait time milliseconds before running the function.
|
Wait time seconds before running the function.
|
||||||
Specify no time to remove condition.
|
Specify no time to remove condition.
|
||||||
|
|
||||||
</ul>
|
</ul>
|
||||||
|
|
@ -833,7 +833,7 @@
|
||||||
<ul>
|
<ul>
|
||||||
<li><span class="parameter">dt</span>
|
<li><span class="parameter">dt</span>
|
||||||
<span class="types"><span class="type">number</span></span>
|
<span class="types"><span class="type">number</span></span>
|
||||||
the delta-time (time spent since last time the function was called) (miliseconds)
|
the delta-time (time spent since last time the function was called) (seconds)
|
||||||
</li>
|
</li>
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
|
|
@ -892,7 +892,7 @@
|
||||||
<ul>
|
<ul>
|
||||||
<li><span class="parameter">dt</span>
|
<li><span class="parameter">dt</span>
|
||||||
<span class="types"><span class="type">number</span></span>
|
<span class="types"><span class="type">number</span></span>
|
||||||
the delta-time (time spent since last time the function was called) (miliseconds)
|
the delta-time (time spent since last time the function was called) (seconds)
|
||||||
</li>
|
</li>
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
|
|
@ -1047,7 +1047,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-25 20:46:24 </i>
|
<i style="float:right;">Last updated 2021-12-25 23:19:42 </i>
|
||||||
</div> <!-- id="about" -->
|
</div> <!-- id="about" -->
|
||||||
</div> <!-- id="container" -->
|
</div> <!-- id="container" -->
|
||||||
</body>
|
</body>
|
||||||
|
|
|
||||||
|
|
@ -86,7 +86,7 @@
|
||||||
|
|
||||||
<ul>
|
<ul>
|
||||||
<li>All distances are expressed in pixels (px)</li>
|
<li>All distances are expressed in pixels (px)</li>
|
||||||
<li>All durations are expressed in seconds (ms)</li>
|
<li>All durations are expressed in seconds (s)</li>
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
|
@ -364,7 +364,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-25 20:46:24 </i>
|
<i style="float:right;">Last updated 2021-12-25 23:19:42 </i>
|
||||||
</div> <!-- id="about" -->
|
</div> <!-- id="about" -->
|
||||||
</div> <!-- id="container" -->
|
</div> <!-- id="container" -->
|
||||||
</body>
|
</body>
|
||||||
|
|
|
||||||
|
|
@ -779,7 +779,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-25 20:46:24 </i>
|
<i style="float:right;">Last updated 2021-12-25 23:19:42 </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-25 20:46:24 </i>
|
<i style="float:right;">Last updated 2021-12-25 23:19:42 </i>
|
||||||
</div> <!-- id="about" -->
|
</div> <!-- id="about" -->
|
||||||
</div> <!-- id="container" -->
|
</div> <!-- id="container" -->
|
||||||
</body>
|
</body>
|
||||||
|
|
|
||||||
|
|
@ -69,7 +69,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-25 20:46:24 </i>
|
<i style="float:right;">Last updated 2021-12-25 23:19:42 </i>
|
||||||
</div> <!-- id="about" -->
|
</div> <!-- id="about" -->
|
||||||
</div> <!-- id="container" -->
|
</div> <!-- id="container" -->
|
||||||
</body>
|
</body>
|
||||||
|
|
|
||||||
2
init.lua
2
init.lua
|
|
@ -26,7 +26,7 @@
|
||||||
-- Units used in the API documentation, unless written otherwise:
|
-- Units used in the API documentation, unless written otherwise:
|
||||||
--
|
--
|
||||||
-- * All distances are expressed in pixels (px)
|
-- * All distances are expressed in pixels (px)
|
||||||
-- * All durations are expressed in seconds (ms)
|
-- * All durations are expressed in seconds (s)
|
||||||
--
|
--
|
||||||
-- These units are only used to make writing documentation easier; you can use other units if you want, as long as you're consistent.
|
-- These units are only used to make writing documentation easier; you can use other units if you want, as long as you're consistent.
|
||||||
--
|
--
|
||||||
|
|
|
||||||
|
|
@ -31,7 +31,7 @@ local timer_mt = {
|
||||||
-- @local
|
-- @local
|
||||||
t = nil,
|
t = nil,
|
||||||
|
|
||||||
--- Wait time milliseconds before running the function.
|
--- Wait time seconds before running the function.
|
||||||
-- Specify no time to remove condition.
|
-- Specify no time to remove condition.
|
||||||
after = function(self, time)
|
after = function(self, time)
|
||||||
self.t.after = time
|
self.t.after = time
|
||||||
|
|
@ -148,7 +148,7 @@ local timer_mt = {
|
||||||
|
|
||||||
--- Update the timer.
|
--- Update the timer.
|
||||||
-- Should be called at every game update.
|
-- Should be called at every game update.
|
||||||
-- @tparam number dt the delta-time (time spent since last time the function was called) (miliseconds)
|
-- @tparam number dt the delta-time (time spent since last time the function was called) (seconds)
|
||||||
update = function(self, dt)
|
update = function(self, dt)
|
||||||
local t = self.t
|
local t = self.t
|
||||||
if not t.dead then
|
if not t.dead then
|
||||||
|
|
@ -225,7 +225,7 @@ timer_mt.__index = timer_mt
|
||||||
local registry_mt = {
|
local registry_mt = {
|
||||||
--- Update all the timers in the registry.
|
--- Update all the timers in the registry.
|
||||||
-- Should be called at every game update; called by ubiquitousse.update.
|
-- Should be called at every game update; called by ubiquitousse.update.
|
||||||
-- @tparam number dt the delta-time (time spent since last time the function was called) (miliseconds)
|
-- @tparam number dt the delta-time (time spent since last time the function was called) (seconds)
|
||||||
update = function(self, dt)
|
update = function(self, dt)
|
||||||
-- process timers
|
-- process timers
|
||||||
for _, timer in ipairs(self.timers) do
|
for _, timer in ipairs(self.timers) do
|
||||||
|
|
@ -285,7 +285,7 @@ timer_module = {
|
||||||
-- The function will receive as first parameter the timer object.
|
-- The function will receive as first parameter the timer object.
|
||||||
-- As a second parameter, the function will receive the delta time (dt).
|
-- As a second parameter, the function will receive the delta time (dt).
|
||||||
-- As a third parameter, the function will receive the lag time (difference between the time when the function was run and when it should have been run).
|
-- As a third parameter, the function will receive the lag time (difference between the time when the function was run and when it should have been run).
|
||||||
-- As a fourth parameter, the function will receive as first parameter the wait(time) function, which will pause the function execution for time miliseconds.
|
-- As a fourth parameter, the function will receive as first parameter the wait(time) function, which will pause the function execution for time seconds.
|
||||||
-- You will need to call the :update(dt) method on the timer object every frame to make it do something, or create the timer from a timer registry if you
|
-- You will need to call the :update(dt) method on the timer object every frame to make it do something, or create the timer from a timer registry if you
|
||||||
-- don't want to handle your timers manually.
|
-- don't want to handle your timers manually.
|
||||||
-- @tparam[opt] function func the function to schedule
|
-- @tparam[opt] function func the function to schedule
|
||||||
|
|
@ -325,7 +325,7 @@ timer_module = {
|
||||||
-- don't want to handle your timers manually.
|
-- don't want to handle your timers manually.
|
||||||
--
|
--
|
||||||
--
|
--
|
||||||
-- @tparam number duration tween duration (miliseconds)
|
-- @tparam number duration tween duration (seconds)
|
||||||
-- @tparam table tbl the table containing the values to tween
|
-- @tparam table tbl the table containing the values to tween
|
||||||
-- @tparam table to the new values
|
-- @tparam table to the new values
|
||||||
-- @tparam[opt="linear"] string/function method tweening method (string name or the actual function(time, start, change, duration))
|
-- @tparam[opt="linear"] string/function method tweening method (string name or the actual function(time, start, change, duration))
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue