From 489d0b4ba7e7f3f8d401be4ec85c3c33408c2e4d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=C3=89tienne=20Reuh=20Fildadut?= Date: Sat, 25 Dec 2021 23:20:17 +0100 Subject: [PATCH] Fix milliseconds remnants in doc --- docs/index.html | 2 +- docs/modules/asset.html | 2 +- docs/modules/ecs.html | 5 +++-- docs/modules/ldtk.html | 2 +- docs/modules/scene.html | 2 +- docs/modules/signal.html | 2 +- docs/modules/timer.html | 14 +++++++------- docs/modules/ubiquitousse.html | 4 ++-- docs/modules/util.html | 2 +- docs/topics/LICENSE.html | 2 +- docs/topics/README.md.html | 2 +- init.lua | 2 +- timer/timer.lua | 10 +++++----- 13 files changed, 26 insertions(+), 25 deletions(-) diff --git a/docs/index.html b/docs/index.html index 7d9c4f5..f7bbfd8 100644 --- a/docs/index.html +++ b/docs/index.html @@ -110,7 +110,7 @@
generated by LDoc 1.4.6 -Last updated 2021-12-25 20:46:24 +Last updated 2021-12-25 23:19:42
diff --git a/docs/modules/asset.html b/docs/modules/asset.html index c288227..bb205c1 100644 --- a/docs/modules/asset.html +++ b/docs/modules/asset.html @@ -329,7 +329,7 @@
generated by LDoc 1.4.6 -Last updated 2021-12-25 20:46:24 +Last updated 2021-12-25 23:19:42
diff --git a/docs/modules/ecs.html b/docs/modules/ecs.html index 02a3a48..240aee7 100644 --- a/docs/modules/ecs.html +++ b/docs/modules/ecs.html @@ -603,7 +603,8 @@ System.default
- Defaults value to put into the entities’s system table when they are added. Will recursively fill missing values.

+ 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.

When an entity is added to a system, a .entity field is always set in the system table, referring to the full entity table.

@@ -1365,7 +1366,7 @@
generated by LDoc 1.4.6 -Last updated 2021-12-25 20:46:24 +Last updated 2021-12-25 23:19:42
diff --git a/docs/modules/ldtk.html b/docs/modules/ldtk.html index 5cef46f..270ce3e 100644 --- a/docs/modules/ldtk.html +++ b/docs/modules/ldtk.html @@ -1644,7 +1644,7 @@ end
generated by LDoc 1.4.6 -Last updated 2021-12-25 20:46:24 +Last updated 2021-12-25 23:19:42
diff --git a/docs/modules/scene.html b/docs/modules/scene.html index a3aa481..d7efc46 100644 --- a/docs/modules/scene.html +++ b/docs/modules/scene.html @@ -672,7 +672,7 @@
generated by LDoc 1.4.6 -Last updated 2021-12-25 20:46:24 +Last updated 2021-12-25 23:19:42
diff --git a/docs/modules/signal.html b/docs/modules/signal.html index 73cd6a8..65c7c7b 100644 --- a/docs/modules/signal.html +++ b/docs/modules/signal.html @@ -403,7 +403,7 @@
generated by LDoc 1.4.6 -Last updated 2021-12-25 20:46:24 +Last updated 2021-12-25 23:19:42
diff --git a/docs/modules/timer.html b/docs/modules/timer.html index f5eba94..29aebb9 100644 --- a/docs/modules/timer.html +++ b/docs/modules/timer.html @@ -85,7 +85,7 @@ - + @@ -242,7 +242,7 @@ The function will receive as first parameter the timer object. 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 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 don’t want to handle your timers manually. @@ -289,7 +289,7 @@ @@ -833,7 +833,7 @@ @@ -892,7 +892,7 @@ @@ -1047,7 +1047,7 @@
generated by LDoc 1.4.6 -Last updated 2021-12-25 20:46:24 +Last updated 2021-12-25 23:19:42
diff --git a/docs/modules/ubiquitousse.html b/docs/modules/ubiquitousse.html index df61cc0..3859ca8 100644 --- a/docs/modules/ubiquitousse.html +++ b/docs/modules/ubiquitousse.html @@ -86,7 +86,7 @@ @@ -364,7 +364,7 @@
generated by LDoc 1.4.6 -Last updated 2021-12-25 20:46:24 +Last updated 2021-12-25 23:19:42
diff --git a/docs/modules/util.html b/docs/modules/util.html index 792d17d..4766df8 100644 --- a/docs/modules/util.html +++ b/docs/modules/util.html @@ -779,7 +779,7 @@
generated by LDoc 1.4.6 -Last updated 2021-12-25 20:46:24 +Last updated 2021-12-25 23:19:42
diff --git a/docs/topics/LICENSE.html b/docs/topics/LICENSE.html index ebd6b5e..67db8be 100644 --- a/docs/topics/LICENSE.html +++ b/docs/topics/LICENSE.html @@ -64,7 +64,7 @@
generated by LDoc 1.4.6 -Last updated 2021-12-25 20:46:24 +Last updated 2021-12-25 23:19:42
diff --git a/docs/topics/README.md.html b/docs/topics/README.md.html index 0126ecf..03b39e7 100644 --- a/docs/topics/README.md.html +++ b/docs/topics/README.md.html @@ -69,7 +69,7 @@
generated by LDoc 1.4.6 -Last updated 2021-12-25 20:46:24 +Last updated 2021-12-25 23:19:42
diff --git a/init.lua b/init.lua index 2aa5691..82d2497 100644 --- a/init.lua +++ b/init.lua @@ -26,7 +26,7 @@ -- Units used in the API documentation, unless written otherwise: -- -- * 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. -- diff --git a/timer/timer.lua b/timer/timer.lua index 2d305d6..6c7b7e3 100644 --- a/timer/timer.lua +++ b/timer/timer.lua @@ -31,7 +31,7 @@ local timer_mt = { -- @local t = nil, - --- Wait time milliseconds before running the function. + --- Wait time seconds before running the function. -- Specify no time to remove condition. after = function(self, time) self.t.after = time @@ -148,7 +148,7 @@ local timer_mt = { --- Update the timer. -- 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) local t = self.t if not t.dead then @@ -225,7 +225,7 @@ timer_mt.__index = timer_mt local registry_mt = { --- Update all the timers in the registry. -- 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) -- process timers for _, timer in ipairs(self.timers) do @@ -285,7 +285,7 @@ timer_module = { -- The function will receive as first parameter the timer object. -- 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 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 -- don't want to handle your timers manually. -- @tparam[opt] function func the function to schedule @@ -325,7 +325,7 @@ timer_module = { -- 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 to the new values -- @tparam[opt="linear"] string/function method tweening method (string name or the actual function(time, start, change, duration))
Timer:after (time)Wait time milliseconds before running the function.Wait time seconds before running the function.
Timer:every (time)