diff --git a/docs/index.html b/docs/index.html index e5413e5..294be24 100644 --- a/docs/index.html +++ b/docs/index.html @@ -108,7 +108,7 @@
generated by LDoc 1.4.6 -Last updated 2021-12-27 16:25:25 +Last updated 2021-12-27 17:22:39
diff --git a/docs/modules/asset.html b/docs/modules/asset.html index c32f285..44225ae 100644 --- a/docs/modules/asset.html +++ b/docs/modules/asset.html @@ -334,7 +334,7 @@
generated by LDoc 1.4.6 -Last updated 2021-12-27 16:25:25 +Last updated 2021-12-27 17:22:39
diff --git a/docs/modules/ecs.html b/docs/modules/ecs.html index a036d61..e90eb15 100644 --- a/docs/modules/ecs.html +++ b/docs/modules/ecs.html @@ -1683,7 +1683,7 @@ its sibling systems (i.e. completely stop the propagation of the event).
generated by LDoc 1.4.6 -Last updated 2021-12-27 16:25:25 +Last updated 2021-12-27 17:22:39
diff --git a/docs/modules/ldtk.html b/docs/modules/ldtk.html index 8b921d2..e91bcac 100644 --- a/docs/modules/ldtk.html +++ b/docs/modules/ldtk.html @@ -1829,7 +1829,7 @@ end Level background.

If there is a background image, background.image contains a table {image=image, x=number, y=number, sx=number, sy=number} - where image is the LÖVE image (or image filepath if LÖVE not available) x and y are the top-left position, + where image is the LÖVE image (or image filepath if LÖVE not available) x and y are the top-left position, and sx and sy the horizontal and vertical scale factors. @@ -1904,7 +1904,7 @@ end

  • Enum are converted into a Lua string giving the currently selected enum value.
  • Filepath are converted into a Lua string giving the file path.
  • Arrays are converted into a Lua table with the elements in it as a list.
    • -
  • Points are converted into a Lua table with the fields x and y: { x=number, y=number }.
    • +
  • Points are converted into a Lua table with the fields x and y: { x=number, y=number }.
  • Colors are converted into a Lua table with the red, green and blue components in [0-1] as a list: {r,g,b}.
    • @@ -1930,7 +1930,7 @@ end
    generated by LDoc 1.4.6 -Last updated 2021-12-27 16:25:25 +Last updated 2021-12-27 17:22:39
    diff --git a/docs/modules/scene.html b/docs/modules/scene.html index 35ce775..15f9f5c 100644 --- a/docs/modules/scene.html +++ b/docs/modules/scene.html @@ -702,7 +702,7 @@
    generated by LDoc 1.4.6 -Last updated 2021-12-27 16:25:25 +Last updated 2021-12-27 17:22:39
    diff --git a/docs/modules/signal.html b/docs/modules/signal.html index 589d471..95da9c4 100644 --- a/docs/modules/signal.html +++ b/docs/modules/signal.html @@ -414,7 +414,7 @@
    generated by LDoc 1.4.6 -Last updated 2021-12-27 16:25:25 +Last updated 2021-12-27 17:22:39
    diff --git a/docs/modules/timer.html b/docs/modules/timer.html index 71c540d..7dbf0b1 100644 --- a/docs/modules/timer.html +++ b/docs/modules/timer.html @@ -1153,7 +1153,7 @@
    generated by LDoc 1.4.6 -Last updated 2021-12-27 16:25:25 +Last updated 2021-12-27 17:22:39
    diff --git a/docs/modules/ubiquitousse.html b/docs/modules/ubiquitousse.html index a0dfefe..9753ba9 100644 --- a/docs/modules/ubiquitousse.html +++ b/docs/modules/ubiquitousse.html @@ -60,29 +60,37 @@

    Module ubiquitousse

    Ubiquitousse main module.

    -

    Set of various Lua libraries to make game development easier, mainly made to be used alongside the LÖVE 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.

    +

    Set of various Lua libraries to make game development easier, mainly made to be used alongside the LÖVE 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.

    -

    This is the main module, which will try to load every other Ubiquitousse module when required and may even provide a few convenience functions.

    +

    This is the main module, which will try to load every other Ubiquitousse module when required, +and also perform a quick LÖVE version check and show a warning in case of potential incompatibility.

    -

    This also perform a quick LÖVE version check and show a warning in case of potential incompatibility.

    +

    Regarding Ubiquitousse’s organization

    -

    Regarding Ubiquitousse’s organization

    +

    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.

    -

    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.

    +

    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 @require tag (e.g., — @require love for LÖVE).

    -

    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 @require tag (e.g., — @require love for LÖVE).

    +

    Some modules are developped in Candran (.can files), but can easily be compiled into regular Lua code. In fact, +you will find precompiled Lua files in the ubiquitousse repository alongside the Candran files, so you don’t have to install Candran yourself and everything +should be pretty much plug and play.

    -

    Some modules are developped in Candran (.can files), but can easily be compiled into regular Lua code.

    +

    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 LDoc fork +which I modified to force LDoc to like me.

    -

    Units used in the API documentation, unless written otherwise:

    +

    If you want to recompile the Candran files or the documentation yourself, there’s a build script make available at the root of +the repository to save you a few seconds.

    + +

    Units used in the API documentation, unless written otherwise:

    -

    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.

    -

    Style:

    +

    Style:

    - -

    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 LDoc fork - which I modified to force LDoc to like me.

    +

    Usage: