diff --git a/doc/index.html b/doc/index.html
index ade3e39..5354e89 100644
--- a/doc/index.html
+++ b/doc/index.html
@@ -153,7 +153,7 @@
| tiny.getSystemIndex (world, system) |
- Gets the index of a System in the World. |
+ Gets the index of the System in the World. |
| tiny.setSystemIndex (world, system, index) |
@@ -322,12 +322,15 @@ end
The active flag is whether or not the System is updated automatically.
Inactive Systems should be updated manually or not at all via
system:update(dt). Defaults to true.
- The 'entities' field is an ordered list of Entities in the System. This
+ The entities field is an ordered list of Entities in the System. This
list can be used to quickly iterate through all Entities in a System.
The interval field is an optional field that makes Systems update at
certain intervals using buffered time, regardless of World update frequency.
For example, to make a System update once a second, set the System's interval
to 1.
+ The index field is the System's index in the World. Lower indexed
+ Systems are processed before higher indices. The index is a read only
+ field; to set the index, use tiny.setSystemIndex(world, system).
The indices field is a table of Entity keys to their indices in the
entities list. Most Systems can ignore this.
The modified flag is an indicator if the System has been modified in
@@ -446,7 +449,8 @@ end
Creates a new World.
- Can optionally add default Systems and Entities.
+ Can optionally add default Systems and Entities. Returns the new World along
+ with default Entities and Systems.
@@ -462,7 +466,7 @@ end
Adds an Entity to the world.
Also call this on Entities that have changed Components such that they
- match different Filters.
+ match different Filters. Returns the Entity.
@@ -476,7 +480,7 @@ end
tiny.addSystem (world, system)
- Adds a System to the world.
+ Adds a System to the world. Returns the System.
@@ -490,7 +494,8 @@ end
tiny.add (world, ...)
- Shortcut for adding multiple Entities and Systems to the World.
+ Shortcut for adding multiple Entities and Systems to the World. Returns all
+ added Entities and Systems.
@@ -504,7 +509,7 @@ end
tiny.removeEntity (world, entity)
- Removes an Entity to the World.
+ Removes an Entity to the World. Returns the Entity.
@@ -518,7 +523,7 @@ end
tiny.removeSystem (world, system)
- Removes a System from the world.
+ Removes a System from the world. Returns the System.
@@ -532,7 +537,8 @@ end
tiny.remove (world, ...)
- Shortcut for removing multiple Entities and Systems from the World.
+ Shortcut for removing multiple Entities and Systems from the World. Returns
+ all rmeove Systems and Entities
@@ -619,8 +625,8 @@ end
tiny.getSystemIndex (world, system)
- Gets the index of a System in the World. Lower indexed Systems are processed
- before higher indexed systems.
+ Gets the index of the System in the World.
+ A simpler alternative is system.index.
@@ -636,7 +642,7 @@ end
Sets the index of a System in the World, and returns the old index. Changes
the order in which they Systems processed, because lower indexed Systems are
- processed first.
+ processed first. Returns the old system.index.
@@ -652,7 +658,7 @@ end
generated by LDoc 1.4.3
-
Last updated 2015-06-19 19:45:33
+
Last updated 2015-07-07 20:41:42