From 4ae55c2274d15891532897d93f6c24945f7d2a3a Mon Sep 17 00:00:00 2001 From: bakpakin Date: Tue, 16 Jun 2015 23:51:31 -0400 Subject: [PATCH] Update to version 2.0-1 --- doc/index.html | 404 +++++++++++---------------------------------- doc/ldoc_fixed.css | 21 +-- 2 files changed, 101 insertions(+), 324 deletions(-) diff --git a/doc/index.html b/doc/index.html index 5d7e6fb..5452439 100644 --- a/doc/index.html +++ b/doc/index.html @@ -46,8 +46,10 @@

Module tiny-ecs

+

+

Info:

+ +

If table is nil, this function uses an empty table. + -

Returns:

-
    - A new System or System class -
@@ -372,41 +376,11 @@ users should mostly ignore this, too. tiny.processingSystem (table)
- Creates a Processing System.

- -

A Processing System iterates through its Entities in no particluar order, and - updates them individually. It has two important fields:

- -
    -
  • function system:process(entity, dt)
    • -
  • function system:filter(entity)
    • -
+ Creates a new Processing System or Processing System class. Shortcut for + tiny.system(table, { "process" }). -

There are also a few other optional callbacks, including the optional - callbacks in tiny.system:

-
    -
  • function system:preProcess(entities, dt)
    • -
  • function system:postProcess(entities, dt)
    • -
- - -

Processing System. - - -

Parameters:

-
    -
  • table - A table to be used as a System, or nil to create a new -
    • -
- -

Returns:

-
    - - A new Processing System or Processing System class -

See also:

@@ -417,56 +391,30 @@ users should mostly ignore this, too.
- - tiny.sortedSystem (table) + + tiny.getSystemEntityCount (system)
- Creates a Sorted Processing System. A Sorted System iterates through its - Entities in a specific order, and updates them individually. It has three - important methods:

- -
    -
  • function system:process(entity, dt)
    • -
  • function system:compare(entity1, entity2)
    • -
  • function system:filter(entity)
    • -
+ Get number of Entities in the System. -

Sorted Systems have the same optitonal callbacks as ProcessingSystems. - Sorted System. -

Parameters:

-
    -
  • table - A table to be used as a System, or nil to create a new -
    • -
-

Returns:

-
    - - A new Sorted System or Sorted System class -
- - -

See also:

-
-

World functions

+

World functions

- A World is a container that manages Entities and Systems. Typically, a +
+ A World is a container that manages Entities and Systems. Typically, a program uses one World at a time.

-

For all World functions except tiny.world(…), object-oriented syntax can +

For all World functions except tiny.world(...), object-oriented syntax can be used instead of the documented syntax. For example, tiny.add(world, e1, e2, e3) is the same as world:add(e1, e2, e3). +

@@ -477,18 +425,7 @@ users should mostly ignore this, too. Can optionally add default Systems and Entities. -

Parameters:

-
    -
  • ... - Systems and Entities to add to the World -
    • -
-

Returns:

-
    - - A new World -
@@ -504,17 +441,6 @@ users should mostly ignore this, too. match different Filters. -

Parameters:

-
    -
  • world - - -
    • -
  • entity - - -
    • -
@@ -529,17 +455,6 @@ users should mostly ignore this, too. Adds a System to the world. -

Parameters:

-
    -
  • world - - -
    • -
  • system - - -
    • -
@@ -554,24 +469,9 @@ users should mostly ignore this, too. Shortcut for adding multiple Entities and Systems to the World. -

Parameters:

-
    -
  • world - - -
    • -
  • ... - Systems and Entities -
    • -
-

See also:

- @@ -583,17 +483,6 @@ users should mostly ignore this, too. Removes an Entity to the World. -

Parameters:

-
    -
  • world - - -
    • -
  • entity - - -
    • -
@@ -608,17 +497,6 @@ users should mostly ignore this, too. Removes a System from the world. -

Parameters:

-
    -
  • world - - -
    • -
  • system - - -
    • -
@@ -633,46 +511,22 @@ users should mostly ignore this, too. Shortcut for removing multiple Entities and Systems from the World. -

Parameters:

-
    -
  • world - - -
    • -
  • ... - Systems and Entities -
    • -
-

See also:

-
- tiny.update (world, dt) + tiny.update (world, dt, filter)
- Updates the World. - Put this in your main loop. + Updates the World by dt (delta time). Takes an optional parameter, filter, + which is a Filter that selects Systems from the World. Only selected Systems + are updated. Put this function in your main loop. -

Parameters:

-
    -
  • world - - -
    • -
  • dt - Delta time -
    • -
@@ -687,13 +541,6 @@ users should mostly ignore this, too. Removes all Entities from the World. -

Parameters:

-
    -
  • world - - -
    • -
@@ -708,13 +555,6 @@ users should mostly ignore this, too. Removes all Systems from the World. -

Parameters:

-
    -
  • world - - -
    • -
@@ -729,20 +569,8 @@ users should mostly ignore this, too. Gets number of Entities in the World. -

Parameters:

-
    -
  • world -
    • -
- -

Returns:

-
    - - An integer -
- @@ -755,20 +583,8 @@ users should mostly ignore this, too. Gets number of Systems in World. -

Parameters:

-
    -
  • world -
    • -
- -

Returns:

-
    - - An integer -
- @@ -782,24 +598,8 @@ users should mostly ignore this, too. before higher indexed systems. -

Parameters:

-
    -
  • world -
    • -
  • system - - -
    • -
- -

Returns:

-
    - - An integer between 1 and world:getSystemCount() inclusive -
- @@ -809,33 +609,13 @@ users should mostly ignore this, too. tiny.setSystemIndex (world, system, index)
- Sets the index of a System in the World. Changes the order in - which they Systems processed, because lower indexed Systems are processed - first. + 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. -

Parameters:

-
    -
  • world -
    • -
  • system - - -
    • -
  • index - - -
    • -
- -

Returns:

-
    - - Old index -
- @@ -847,7 +627,7 @@ users should mostly ignore this, too.
generated by LDoc 1.4.3 -Last updated 2015-05-07 19:57:49 +Last updated 2015-06-16 23:50:18
diff --git a/doc/ldoc_fixed.css b/doc/ldoc_fixed.css index 45b5689..7942f1f 100644 --- a/doc/ldoc_fixed.css +++ b/doc/ldoc_fixed.css @@ -28,7 +28,7 @@ del,ins { text-decoration: none; } li { - list-style: bullet; + list-style: disc; margin-left: 20px; } caption,th { @@ -114,24 +114,18 @@ p.name { padding-top: 1em; } -pre.example { - background-color: rgb(245, 245, 245); - border: 1px solid silver; - padding: 10px; - margin: 10px 0 10px 0; - font-family: "Andale Mono", monospace; - font-size: .85em; -} - pre { - background-color: rgb(245,245,255); // rgb(245, 245, 245); - border: 1px solid #cccccc; //silver; + background-color: rgb(245, 245, 245); + border: 1px solid #C0C0C0; /* silver */ padding: 10px; margin: 10px 0 10px 0; overflow: auto; font-family: "Andale Mono", monospace; } +pre.example { + font-size: .85em; +} table.index { border: 1px #00007f; } table.index td { text-align: left; vertical-align: top; } @@ -299,6 +293,7 @@ a:target + * { background-color: #FF9; } + /* styles for prettification of source */ pre .comment { color: #558817; } pre .constant { color: #a8660d; } @@ -311,5 +306,7 @@ pre .number { color: #f8660d; } pre .operator { color: #2239a8; font-weight: bold; } pre .preprocessor, pre .prepro { color: #a33243; } pre .global { color: #800080; } +pre .user-keyword { color: #800080; } pre .prompt { color: #558817; } pre .url { color: #272fc2; text-decoration: underline; } +