From 7979226c3314de5dded9d126c6fb962f4b1ff721 Mon Sep 17 00:00:00 2001 From: Josh Perry Date: Tue, 18 Aug 2020 15:20:56 +0100 Subject: [PATCH] Regenerated docs --- docs/classes/Component.html | 6 +- docs/classes/Entity.html | 15 +-- docs/classes/List.html | 186 ++++++++++++++++------------------- docs/classes/Pool.html | 106 +++++++++++--------- docs/classes/System.html | 89 ++--------------- docs/classes/World.html | 9 +- docs/index.html | 23 +---- docs/modules/Components.html | 185 ++++++++++++++++++++++++++++++++++ docs/modules/Concord.html | 121 +---------------------- docs/modules/type.html | 36 +------ docs/modules/utils.html | 41 +++++++- 11 files changed, 387 insertions(+), 430 deletions(-) create mode 100644 docs/modules/Components.html diff --git a/docs/classes/Component.html b/docs/classes/Component.html index ad4f3e2..7e0358c 100644 --- a/docs/classes/Component.html +++ b/docs/classes/Component.html @@ -38,7 +38,6 @@

Classes

Modules

@@ -163,7 +159,7 @@
generated by LDoc 1.4.6 -Last updated 2020-01-04 10:27:07 +Last updated 2020-08-18 15:20:32
diff --git a/docs/classes/Entity.html b/docs/classes/Entity.html index 5ecd569..b263a9f 100644 --- a/docs/classes/Entity.html +++ b/docs/classes/Entity.html @@ -38,7 +38,6 @@

Classes

Modules

@@ -64,8 +60,7 @@

Class Entity

An object that exists in a world.

An entity - contains components which are processed by systems. -

+ contains components which are processed by systems.

Methods

@@ -251,11 +246,11 @@

Parameters:

@@ -413,7 +408,7 @@
generated by LDoc 1.4.6 -Last updated 2020-01-04 10:27:07 +Last updated 2020-08-18 15:20:32
diff --git a/docs/classes/List.html b/docs/classes/List.html index b6becb6..414888a 100644 --- a/docs/classes/List.html +++ b/docs/classes/List.html @@ -33,13 +33,11 @@

Contents

Classes

Modules

@@ -74,6 +69,18 @@ Creates a new List. + List:add (obj) + Adds an object to the List. + + + List:remove (obj) + Removes an object from the List. + + + List:clear () + Clears the List completely. + + List:has (obj) Returns true if the List has the object. @@ -86,21 +93,6 @@ Returns the index of an object in the List. -

Metamethods

- - - - - - - - - - - - - -
List:__add (obj)Adds an object to the List.
List:__remove (obj)Removes an object from the List.
List:__clear ()Clears the List completely.


@@ -128,6 +120,80 @@ + +
+ + List:add (obj) +
+
+ Adds an object to the List. + Object must be of reference type + Object may not be the string 'size' + + +

Parameters:

+ + +

Returns:

+
    + + List + self +
+ + + + +
+
+ + List:remove (obj) +
+
+ Removes an object from the List. + + +

Parameters:

+ + +

Returns:

+
    + + List + self +
+ + + + +
+
+ + List:clear () +
+
+ Clears the List completely. + + + +

Returns:

+
    + + List + self +
+ + + +
@@ -206,84 +272,6 @@ - - -

Metamethods

- -
-
- - List:__add (obj) -
-
- Adds an object to the List. - Object must be of reference type - Object may not be the string 'size' - - -

Parameters:

-
    -
  • obj - Object to add -
    • -
- -

Returns:

-
    - - List - self -
- - - - -
-
- - List:__remove (obj) -
-
- Removes an object from the List. - - -

Parameters:

-
    -
  • obj - Object to remove -
    • -
- -

Returns:

-
    - - List - self -
- - - - -
-
- - List:__clear () -
-
- Clears the List completely. - - - -

Returns:

-
    - - List - self -
- - - -
@@ -292,7 +280,7 @@
generated by LDoc 1.4.6 -Last updated 2020-01-04 10:27:07 +Last updated 2020-08-18 15:20:32
diff --git a/docs/classes/Pool.html b/docs/classes/Pool.html index 184ad8c..77be777 100644 --- a/docs/classes/Pool.html +++ b/docs/classes/Pool.html @@ -33,13 +33,11 @@

Contents

Classes

Modules

@@ -75,6 +70,14 @@ Creates a new Pool + Pool:eligible (e) + Checks if an Entity is eligible for the Pool. + + + Pool:evaluate (e) + Evaluate whether an Entity should be added or removed from the Pool. + + Pool:getName () Gets the name of the Pool @@ -87,13 +90,6 @@ Callback for when an Entity is added to the Pool. -

Metamethods

- - - - - -
Pool:__eligible (e)Checks if an Entity is eligible for the Pool.


@@ -132,6 +128,59 @@ + +
+ + Pool:eligible (e) +
+
+ Checks if an Entity is eligible for the Pool. + + +

Parameters:

+ + +

Returns:

+
    + + boolean + +
+ + + + +
+
+ + Pool:evaluate (e) +
+
+ Evaluate whether an Entity should be added or removed from the Pool. + + +

Parameters:

+ + +

Returns:

+
    + + Pool + self +
+ + + +
@@ -193,37 +242,6 @@ - - -

Metamethods

- -
-
- - Pool:__eligible (e) -
-
- Checks if an Entity is eligible for the Pool. - - -

Parameters:

-
    -
  • e - Entity - Entity to check -
    • -
- -

Returns:

-
    - - boolean - -
- - - -
@@ -232,7 +250,7 @@
generated by LDoc 1.4.6 -Last updated 2020-01-04 10:27:07 +Last updated 2020-08-18 15:20:32
diff --git a/docs/classes/System.html b/docs/classes/System.html index 914bd9b..a73ed8b 100644 --- a/docs/classes/System.html +++ b/docs/classes/System.html @@ -39,7 +39,6 @@

Classes

Modules

@@ -66,29 +62,16 @@

Iterates over Entities.

From these Entities its get Components and modify them. A System contains 1 or more Pools. - A System is contained by 1 World. -

+ A System is contained by 1 World.

Methods

- + - - - - - - - - - - - - @@ -134,7 +117,7 @@
- System:new (...) + System:new (table)
Creates a new SystemClass. @@ -142,8 +125,8 @@

Parameters:

    -
  • ... - Variable amounts of filters +
  • table + filters A table containing filters (name = {components...})
@@ -157,66 +140,6 @@ -
-
- - System:enable () -
-
- Enables the System. - - - -

Returns:

-
    - - System - self -
- - - - -
-
- - System:disable () -
-
- Disables the System. - - - -

Returns:

-
    - - System - self -
- - - - -
-
- - System:toggleEnabled () -
-
- Toggles if the System is enabled. - - - -

Returns:

-
    - - System - self -
- - - -
@@ -385,7 +308,7 @@
generated by LDoc 1.4.6 -Last updated 2020-01-04 10:27:07 +Last updated 2020-08-18 15:20:32
diff --git a/docs/classes/World.html b/docs/classes/World.html index ce29521..e673fa8 100644 --- a/docs/classes/World.html +++ b/docs/classes/World.html @@ -38,7 +38,6 @@

Classes

Modules

@@ -66,8 +62,7 @@

A world emits to let Systems iterate. A World contains any amount of Systems. - A World contains any amount of Entities. -

+ A World contains any amount of Entities.

Methods

@@ -466,7 +461,7 @@
generated by LDoc 1.4.6 -Last updated 2020-01-04 10:27:07 +Last updated 2020-08-18 15:20:32
diff --git a/docs/index.html b/docs/index.html index 427d6b7..8950dda 100644 --- a/docs/index.html +++ b/docs/index.html @@ -31,17 +31,13 @@

Modules

Classes

System:new (...)System:new (table) Creates a new SystemClass.
System:enable ()Enables the System.
System:disable ()Disables the System.
System:toggleEnabled ()Toggles if the System is enabled.
System:setEnabled (enable) Sets if the System is enabled
- - - - @@ -71,10 +63,6 @@ - - - - - - - -
AssemblagesA container for registered Assemblages
Components Container for registered ComponentClassesConcord
SystemsContainer for registered SystemClasses
type Type @@ -85,18 +73,9 @@ Utils Helper module for misc operations
worldsWorlds - Container for registered Worlds

Classes

- - - - @@ -128,7 +107,7 @@
generated by LDoc 1.4.6 -Last updated 2020-01-04 10:27:07 +Last updated 2020-08-18 15:20:32
diff --git a/docs/modules/Components.html b/docs/modules/Components.html new file mode 100644 index 0000000..de521c2 --- /dev/null +++ b/docs/modules/Components.html @@ -0,0 +1,185 @@ + + + + + Reference + + + + +
+ +
+ +
+
+
+ + +
+ + + + + + +
+ +

Module Components

+

Container for registered ComponentClasses

+

+ + +

Functions

+
AssemblageGives an entity a set of components.
Component A pure data container that is contained by a single entity.
+ + + + + + + + + + + + +
has (name)Returns true if the containter has the ComponentClass with the specified name
try (name)Returns true and the ComponentClass if one was registered with the specified name + or false and an error otherwise
get (name)Returns the ComponentClass with the specified name
+ +
+
+ + +

Functions

+ +
+
+ + has (name) +
+
+ Returns true if the containter has the ComponentClass with the specified name + + +

Parameters:

+
    +
  • name + string + Name of the ComponentClass to check +
    • +
+ +

Returns:

+
    + + boolean + +
+ + + + +
+
+ + try (name) +
+
+ Returns true and the ComponentClass if one was registered with the specified name + or false and an error otherwise + + +

Parameters:

+
    +
  • name + string + Name of the ComponentClass to check +
    • +
+ +

Returns:

+
    +
  1. + boolean +
    2. +
  2. + Component + or error string
    3. +
+ + + + +
+
+ + get (name) +
+
+ Returns the ComponentClass with the specified name + + +

Parameters:

+
    +
  • name + string + Name of the ComponentClass to get +
    • +
+ +

Returns:

+
    + + Component + +
+ + + + +
+
+ + + + +
+generated by LDoc 1.4.6 +Last updated 2020-08-18 15:20:32 +
+ + + diff --git a/docs/modules/Concord.html b/docs/modules/Concord.html index b50ef54..903787f 100644 --- a/docs/modules/Concord.html +++ b/docs/modules/Concord.html @@ -30,25 +30,17 @@
  • Index
    • -

    Contents

    -

    Modules

    Classes