library-mirrors/tiny-ecs
1
0
Fork 0
mirror of https://github.com/bakpakin/tiny-ecs.git synced 2024-11-17 04:44:23 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Update filer documentation to be more explicit.

Browse Source
This commit is contained in:
bakpakin 2016-08-10 19:36:20 -04:00
parent 80bb6b8d31
commit a0fa0904f6
1 changed files with 3 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
tiny.lua
View File

@ -45,7 +45,9 @@ local tiny_removeSystem
--- Filter functions. --- Filter functions.
-- A Filter is a function that selects which Entities apply to a System. -- A Filter is a function that selects which Entities apply to a System.
-- Filters take two parameters, the System and the Entity, and return a boolean -- Filters take two parameters, the System and the Entity, and return a boolean
-- value indicating if the Entity should be processed by the System. -- value indicating if the Entity should be processed by the System. A truthy
-- value includes the entity, while a falsey (nil or false) value excludes the
-- entity.
-- --
-- Filters must be added to Systems by setting the `filter` field of the System. -- Filters must be added to Systems by setting the `filter` field of the System.
-- Filter's returned by tiny-ecs's Filter functions are immutable and can be -- Filter's returned by tiny-ecs's Filter functions are immutable and can be