From a0fa0904f6b76a552e4fe73f8cbef95825644d3e Mon Sep 17 00:00:00 2001 From: bakpakin Date: Wed, 10 Aug 2016 19:36:20 -0400 Subject: [PATCH] Update filer documentation to be more explicit. --- tiny.lua | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/tiny.lua b/tiny.lua index 92326ad..710d4b8 100644 --- a/tiny.lua +++ b/tiny.lua @@ -45,7 +45,9 @@ local tiny_removeSystem --- Filter functions. -- 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 --- 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. -- Filter's returned by tiny-ecs's Filter functions are immutable and can be