33 Commits

Author SHA1 Message Date
Calvin Rose
5997f949cd Update rockspecs. 2016-06-19 11:01:57 -04:00
Calvin Rose
ea6009a8d2 Add a rockspec. 2016-06-18 22:47:06 -04:00
Calvin Rose
7da4efb7df Edit README and remove version from library code for easier release cycle.
I don't like git hooks for that kind of thing and its not really necessary.
2016-06-18 13:35:26 -04:00
Calvin Rose
9bc366a2fb Merge branch 'master' of https://github.com/bakpakin/tiny-ecs 2016-06-18 13:22:08 -04:00
Calvin Rose
80b7b48703 Conform to 80 column lines. 2016-06-18 13:21:34 -04:00
bakpakin
0488bff1d9 Fix slightly incorrect pattern for matching filters (only matters on incorrect filters). 2016-05-19 18:18:39 +08:00
bakpakin
ee192d94af Add init.lua for easy require if used as a submodule. 2016-05-19 17:50:54 +08:00
Calvin Rose
a518e15e44 Merge pull request #7 from tst2005/patch-1
typo fix
2016-04-27 10:30:25 -04:00
TsT
37c2c49300 typo fix
Currenty the `doc = doc` is equal to `doc = nil`.
The "doc" directory is used because it's the internal LDoc default.
2016-04-27 13:55:10 +02:00
Calvin Rose
195c882bbd Add documentation for preWrap and postWrap. 2016-04-13 15:01:53 -04:00
Calvin Rose
29a4a02f30 Add tests for postWrap and preWrap. 2016-04-13 14:39:39 -04:00
Calvin Rose
df5c84033b Add code for preWrap and postWrap to system. 2016-04-13 14:28:38 -04:00
bakpakin
d9c296dae6 Update documentation. 2016-03-06 18:20:18 -05:00
bakpakin
08e5f13d85 Begin experimental option to not use caching. 2016-03-06 14:42:48 -05:00
bakpakin
cbf71d2cb2 Add rockspec for version to 1.3-1 2016-03-05 16:42:14 -05:00
bakpakin
93a19d93c8 Wrap error throwing functions in pcalls and make doc look cleaner for tiny.filter. 2016-03-05 16:35:06 -05:00
bakpakin
4148855233 Bump version. 2016-03-05 16:20:09 -05:00
bakpakin
27f881444a Fix string filter generator. 2016-03-05 16:06:56 -05:00
bakpakin
3b4bd9920b Add generic filter. 2016-03-05 15:34:21 -05:00
bakpakin
206361ca38 Make filters compile. Add some filter tests. 2016-03-05 13:34:44 -05:00
bakpakin
29158282bd Update Copyright Date. 2016-02-29 19:19:34 -05:00
bakpakin
2403a9019c Release version 1.2-1. 2015-09-08 16:25:10 -04:00
bakpakin
6234e4b741 Document onAddToWorld and onRemoveFromWorld. 2015-09-08 16:19:07 -04:00
bakpakin
b870b5a34e Add onAddToWorld and onRemoveFromWorld callbacks to systems. Also, adding or removing systems to a world twice raises an error. 2015-09-08 13:37:53 -04:00
bakpakin
f3b16a40f6 Add some simple assertions to adding and removing systems. 2015-09-08 13:22:07 -04:00
bakpakin
5035d2c8a7 Make the scope of many local variables smaller. 2015-08-27 14:55:24 -04:00
bakpakin
18270cd60a Adding already added entities no longer removes them from the World first, just updates them to relavent Systems. 2015-08-27 14:31:45 -04:00
bakpakin
dba8e7c89f Remove indication of a versioned release in tiny.lua. 2015-08-27 13:51:13 -04:00
bakpakin
fccff0329e Add travis to tiny-ecs. 2015-08-27 13:47:28 -04:00
bakpakin
8a759edca2 Fix docs again. *sigh* 2015-08-27 13:32:51 -04:00
bakpakin
d9d311d858 Fix system docs. 2015-08-27 13:26:09 -04:00
bakpakin
9834dfa9d6 Fix Adding systems and items to the world inside a call to system:onAdd() 2015-08-24 12:52:11 -04:00
bakpakin
a5af4b6ecd Index systems from the end like string.sub. 2015-08-22 22:45:07 -04:00
18 changed files with 600 additions and 223 deletions
+39
View File
@@ -0,0 +1,39 @@
language: erlang
env:
global:
- LUAROCKS_BASE=luarocks-2.2.2
matrix:
- LUA=lua5.1 LUA_DEV=liblua5.1-dev LUA_VER=5.1 LUA_SFX=5.1 LUA_INCDIR=/usr/include/lua5.1
- LUA=lua5.2 LUA_DEV=liblua5.2-dev LUA_VER=5.2 LUA_SFX=5.2 LUA_INCDIR=/usr/include/lua5.2
- LUA=luajit LUA_DEV=libluajit-5.1-dev LUA_VER=5.1 LUA_SFX=jit LUA_INCDIR=/usr/include/luajit-2.0
before_install:
- if [ $LUA = "luajit" ]; then
sudo add-apt-repository ppa:mwild1/ppa -y && sudo apt-get update -y;
sudo apt-get install lua5.1;
sudo apt-get install liblua5.1-dev;
fi
- sudo apt-get install $LUA
- sudo apt-get install $LUA_DEV
- lua$LUA_SFX -v
# Install a recent luarocks release
- wget http://luarocks.org/releases/$LUAROCKS_BASE.tar.gz
- tar zxvpf $LUAROCKS_BASE.tar.gz
- cd $LUAROCKS_BASE
- ./configure
--lua-version=$LUA_VER --lua-suffix=$LUA_SFX --with-lua-include="$LUA_INCDIR"
- sudo make
- sudo make install
- cd $TRAVIS_BUILD_DIR
install:
- sudo -E luarocks install busted
script:
- sudo -E busted -v
notifications:
email:
on_success: change
on_failure: always
+1 -1
View File
@@ -1,4 +1,4 @@
Copyright (c) 2015 Calvin Rose Copyright (c) 2016 Calvin Rose
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+12 -13
View File
@@ -1,26 +1,26 @@
# tiny-ecs # # tiny-ecs #
[![License](http://img.shields.io/badge/Licence-MIT-brightgreen.svg)](LICENSE) [![Build Status](https://travis-ci.org/bakpakin/tiny-ecs.png?branch=master)](https://travis-ci.org/bakpakin/tiny-ecs)[![License](http://img.shields.io/badge/Licence-MIT-brightgreen.svg)](LICENSE)
Tiny-ecs is an Entity Component System for lua that's simple, flexible, and useful. Tiny-ecs is an Entity Component System for Lua that's simple, flexible, and useful.
Because of lua's tabular nature, Entity Component Systems are a natural choice Because of Lua's tabular nature, Entity Component Systems are a natural choice
for simulating large and complex systems. For more explanation on Entity for simulating large and complex systems. For more explanation on Entity
Component Systems, here is some Component Systems, here is some
[basic info](http://en.wikipedia.org/wiki/Entity_component_system "Wikipedia"). [basic info](http://en.wikipedia.org/wiki/Entity_component_system "Wikipedia").
Tiny-ecs also works well with objected oriented programming in lua because Tiny-ecs also works well with objected oriented programming in Lua because
Systems and Entities do not use metatables. This means you can subclass your Systems and Entities do not use metatables. This means you can subclass your
Systems and Entities, and use existing lua class frameworks with tiny-ecs, no problem. Systems and Entities, and use existing Lua class frameworks with tiny-ecs, no problem.
For an example on how to use tiny-ecs with object-oriented lua, take a look at the For an example on how to use tiny-ecs with object-oriented Lua, take a look at the
demo branch, specifically the systems and entities sub-directories. demo branch, specifically the systems and entities sub-directories.
## Overview ## ## Overview ##
Tiny-ecs has four important types: Worlds, Filters, Systems, and Entities. Tiny-ecs has four important types: Worlds, Filters, Systems, and Entities.
Entities, however, can be any lua table, and Filters are just functions that Entities, however, can be any Lua table, and Filters are just functions that
take an Entity as a parameter. take an Entity as a parameter.
### Entities ### ### Entities ###
Entities are simply lua tables of data that gets processed by Systems. Entities Entities are simply Lua tables of data that gets processed by Systems. Entities
should contain primarily data rather than code, as it is the Systems's job to should contain primarily data rather than code, as it is the Systems's job to
do logic on data. Henceforth, a key-value pair in an Entity will do logic on data. Henceforth, a key-value pair in an Entity will
be referred to as a Component. be referred to as a Component.
@@ -37,7 +37,7 @@ provides functions for creating Systems easily, as well as creating Systems that
can be used in an object oriented fashion. can be used in an object oriented fashion.
### Filters ### ### Filters ###
Filters are used to select Entities. Filters can be any lua function, but Filters are used to select Entities. Filters can be any Lua function, but
tiny-ecs provides some functions for generating common ones, like selecting tiny-ecs provides some functions for generating common ones, like selecting
only Entities that have all required components. only Entities that have all required components.
@@ -49,7 +49,7 @@ local talkingSystem = tiny.processingSystem()
talkingSystem.filter = tiny.requireAll("name", "mass", "phrase") talkingSystem.filter = tiny.requireAll("name", "mass", "phrase")
function talkingSystem:process(e, dt) function talkingSystem:process(e, dt)
e.mass = e.mass + dt * 3 e.mass = e.mass + dt * 3
print(e.name .. ", who weighs " .. e.mass .. " pounds, says, \"" .. e.phrase .. "\"") print(("%s who weighs %d pounds, says %q."):format(e.name, e.mass, e.phrase)
end end
local joe = { local joe = {
@@ -68,8 +68,7 @@ end
## Use It ## ## Use It ##
Copy paste tiny.lua into your source folder. For stability and consistent API, Copy paste tiny.lua into your source folder. For stability and consistent API,
please use a tagged release or use luarocks. Tagged releases will have a version please use a tagged release or use luarocks.
number in `tiny._VERSION`, while other commits will just have the string 'scm'.
## Luarocks ## ## Luarocks ##
Tiny-ecs is also on [Luarocks](https://luarocks.org/) and can be installed with Tiny-ecs is also on [Luarocks](https://luarocks.org/) and can be installed with
@@ -78,7 +77,7 @@ Tiny-ecs is also on [Luarocks](https://luarocks.org/) and can be installed with
## Demo ## ## Demo ##
Check out the [demo](https://github.com/bakpakin/tiny-ecs/tree/demo-commandokibbles), a game Check out the [demo](https://github.com/bakpakin/tiny-ecs/tree/demo-commandokibbles), a game
originally written for Ludum Dare 32 with the theme 'An Unconventional Weapon'. The demo uses originally written for Ludum Dare 32 with the theme 'An Unconventional Weapon'. The demo uses
[LÖVE](https://love2d.org/), an amazing game framework for lua. [LÖVE](https://love2d.org/), an amazing game framework for Lua.
## Testing ## ## Testing ##
Tiny-ecs uses [busted](http://olivinelabs.com/busted/) for testing. Install and run Tiny-ecs uses [busted](http://olivinelabs.com/busted/) for testing. Install and run
+1 -1
View File
@@ -5,7 +5,7 @@ backtick_references = true
format = 'discount' format = 'discount'
title = "tiny-ecs API" title = "tiny-ecs API"
one = true one = true
dir = doc dir = "doc"
style = '!fixed' style = '!fixed'
package = 'tiny-ecs' package = 'tiny-ecs'
not_luadoc = true not_luadoc = true
+5
View File
@@ -0,0 +1,5 @@
-- Helper Lua file for easy require if tiny-ecs is used as a git submodule or
-- folder. Not needed in many cases, including luarocks distribution.
local directory = (...):match("(.-)[^%.]+$")
return require(directory .. 'tiny')
+1 -1
View File
@@ -2,7 +2,7 @@ package = "tiny-ecs"
version = "1.0-2" version = "1.0-2"
source = { source = {
url = "git://github.com/bakpakin/tiny-ecs", url = "git://github.com/bakpakin/tiny-ecs",
tag = "1.0-2" tag = version
} }
description = { description = {
summary = "Entity Component System for Lua.", summary = "Entity Component System for Lua.",
+1 -1
View File
@@ -2,7 +2,7 @@ package = "tiny-ecs"
version = "1.1-1" version = "1.1-1"
source = { source = {
url = "git://github.com/bakpakin/tiny-ecs", url = "git://github.com/bakpakin/tiny-ecs",
tag = "1.1-1" tag = version
} }
description = { description = {
summary = "Entity Component System for Lua.", summary = "Entity Component System for Lua.",
+1 -1
View File
@@ -2,7 +2,7 @@ package = "tiny-ecs"
version = "1.1-2" version = "1.1-2"
source = { source = {
url = "git://github.com/bakpakin/tiny-ecs", url = "git://github.com/bakpakin/tiny-ecs",
tag = "1.1-2" tag = version
} }
description = { description = {
summary = "Entity Component System for Lua.", summary = "Entity Component System for Lua.",
+1 -1
View File
@@ -2,7 +2,7 @@ package = "tiny-ecs"
version = "1.1-3" version = "1.1-3"
source = { source = {
url = "git://github.com/bakpakin/tiny-ecs", url = "git://github.com/bakpakin/tiny-ecs",
tag = "1.1-3" tag = version
} }
description = { description = {
summary = "Entity Component System for Lua.", summary = "Entity Component System for Lua.",
+1 -1
View File
@@ -2,7 +2,7 @@ package = "tiny-ecs"
version = "1.1-4" version = "1.1-4"
source = { source = {
url = "git://github.com/bakpakin/tiny-ecs", url = "git://github.com/bakpakin/tiny-ecs",
tag = "1.1-4" tag = version
} }
description = { description = {
summary = "Entity Component System for Lua.", summary = "Entity Component System for Lua.",
+1 -1
View File
@@ -2,7 +2,7 @@ package = "tiny-ecs"
version = "1.1-5" version = "1.1-5"
source = { source = {
url = "git://github.com/bakpakin/tiny-ecs", url = "git://github.com/bakpakin/tiny-ecs",
tag = "1.1-5" tag = version
} }
description = { description = {
summary = "Entity Component System for Lua.", summary = "Entity Component System for Lua.",
+1 -1
View File
@@ -2,7 +2,7 @@ package = "tiny-ecs"
version = "1.1-6" version = "1.1-6"
source = { source = {
url = "git://github.com/bakpakin/tiny-ecs", url = "git://github.com/bakpakin/tiny-ecs",
tag = "1.1-6" tag = version
} }
description = { description = {
summary = "Entity Component System for Lua.", summary = "Entity Component System for Lua.",
+1 -1
View File
@@ -2,7 +2,7 @@ package = "tiny-ecs"
version = "1.1-7" version = "1.1-7"
source = { source = {
url = "git://github.com/bakpakin/tiny-ecs", url = "git://github.com/bakpakin/tiny-ecs",
tag = "1.1-7" tag = version
} }
description = { description = {
summary = "Entity Component System for Lua.", summary = "Entity Component System for Lua.",
+24
View File
@@ -0,0 +1,24 @@
package = "tiny-ecs"
version = "1.2-1"
source = {
url = "git://github.com/bakpakin/tiny-ecs",
tag = version
}
description = {
summary = "Entity Component System for Lua.",
detailed = [[
Pure Lua implementation of an easy to use, compact, fast, and flexible
Entity Component System. Works well with Object Orientation.
]],
homepage = "https://github.com/bakpakin/tiny-ecs",
license = "MIT"
}
dependencies = {
"lua >= 5.1"
}
build = {
type = "builtin",
modules = {
tiny = "tiny.lua"
}
}
+24
View File
@@ -0,0 +1,24 @@
package = "tiny-ecs"
version = "1.3-1"
source = {
url = "git://github.com/bakpakin/tiny-ecs",
tag = version
}
description = {
summary = "Entity Component System for Lua.",
detailed = [[
Pure Lua implementation of an easy to use, compact, fast, and flexible
Entity Component System. Works well with Object Orientation.
]],
homepage = "https://github.com/bakpakin/tiny-ecs",
license = "MIT"
}
dependencies = {
"lua >= 5.1"
}
build = {
type = "builtin",
modules = {
tiny = "tiny.lua"
}
}
+24
View File
@@ -0,0 +1,24 @@
package = "tiny-ecs"
version = "1.3-2"
source = {
url = "git://github.com/bakpakin/tiny-ecs",
tag = version
}
description = {
summary = "Entity Component System for Lua.",
detailed = [[
Pure Lua implementation of an easy to use, compact, fast, and flexible
Entity Component System. Works well with Object Orientation.
]],
homepage = "https://github.com/bakpakin/tiny-ecs",
license = "MIT"
}
dependencies = {
"lua >= 5.1"
}
build = {
type = "builtin",
modules = {
tiny = "tiny.lua"
}
}
+84 -4
View File
@@ -1,3 +1,8 @@
local GLOBALS = {}
for k, v in pairs(_G) do
GLOBALS[k] = v
end
local tiny = require "tiny" local tiny = require "tiny"
local function deep_copy(x) local function deep_copy(x)
@@ -85,6 +90,49 @@ describe('tiny-ecs:', function()
end) end)
it("Can use functions as subfilters", function()
local f1 = tiny.requireAny('a', 'b', 'c')
local f2 = tiny.requireAll('x', 'y', 'z')
local f = tiny.requireAll(f1, f2)
assert.truthy(f(nil, {
x = true, y = true, z = true, a = true, b = true, c = true
}))
assert.truthy(f(nil, {
x = true, y = true, z = true, a = true
}))
assert.falsy(f(nil, {
x = true, y = true, a = true
}))
assert.falsy(f(nil, {
x = true, y = true, z = true
}))
end)
it("Can use string filters", function()
local f = tiny.filter('a|b|c')
assert.truthy(f(nil, {
a = true, b = true, c = true
}))
assert.truthy(f(nil, {
a = true
}))
assert.truthy(f(nil, {
b = true
}))
assert.truthy(f(nil, {
c = true
}))
assert.falsy(f(nil, {
x = true, y = true, z = true
}))
end)
end) end)
describe('World:', function() describe('World:', function()
@@ -115,6 +163,11 @@ describe('tiny-ecs:', function()
timePassed = 0 timePassed = 0
end) end)
after_each(function()
world:clearSystems()
world:refresh()
end)
it("Create World", function() it("Create World", function()
assert.equals(world:getEntityCount(), 3) assert.equals(world:getEntityCount(), 3)
assert.equals(world:getSystemCount(), 2) assert.equals(world:getSystemCount(), 2)
@@ -180,9 +233,11 @@ describe('tiny-ecs:', function()
end) end)
it("Remove Entities Multiple Times", function() it("Remove Entities Multiple Times", function()
assert.equals(3, world:getEntityCount())
world:update(1) world:update(1)
world:remove(entity1, entity2, entity3) world:remove(entity1, entity2, entity3)
world:update(2) world:update(2)
assert.equals(0, world:getEntityCount())
world:remove(entity1, entity2, entity3) world:remove(entity1, entity2, entity3)
world:update(2) world:update(2)
assert.equals(2, world:getSystemCount()) assert.equals(2, world:getSystemCount())
@@ -191,7 +246,7 @@ describe('tiny-ecs:', function()
it("Add Systems Multiple Times", function() it("Add Systems Multiple Times", function()
world:update(1) world:update(1)
world:add(moveSystem, oneTimeSystem) assert.has_error(function() world:add(moveSystem, oneTimeSystem) end, "System already belongs to a World.")
world:update(2) world:update(2)
assert.equals(2, world:getSystemCount()) assert.equals(2, world:getSystemCount())
assert.equals(3, world:getEntityCount()) assert.equals(3, world:getEntityCount())
@@ -201,7 +256,7 @@ describe('tiny-ecs:', function()
world:update(1) world:update(1)
world:remove(moveSystem) world:remove(moveSystem)
world:update(2) world:update(2)
world:remove(moveSystem) assert.has_error(function() world:remove(moveSystem) end, "System does not belong to this World.")
world:update(2) world:update(2)
assert.equals(1, world:getSystemCount()) assert.equals(1, world:getSystemCount())
assert.equals(3, world:getEntityCount()) assert.equals(3, world:getEntityCount())
@@ -217,17 +272,42 @@ describe('tiny-ecs:', function()
it("Sorts Entities in Sorting Systems", function() it("Sorts Entities in Sorting Systems", function()
local sortsys = tiny.sortedProcessingSystem() local sortsys = tiny.sortedProcessingSystem()
sortsys.filter = tiny.requireAll("vel") sortsys.filter = tiny.filter("vel|xform")
function sortsys:compare(e1, e2) function sortsys:compare(e1, e2)
return e1.vel.x < e2.vel.x return e1.vel.x < e2.vel.x
end end
world:add(sortsys) world:add(sortsys)
world:update(0) world:refresh()
assert.equals(sortsys.entities[1], entity2) assert.equals(sortsys.entities[1], entity2)
assert.equals(sortsys.entities[2], entity3) assert.equals(sortsys.entities[2], entity3)
assert.equals(sortsys.entities[3], entity1) assert.equals(sortsys.entities[3], entity1)
end) end)
it("Runs preWrap and postWrap for systems.", function()
local str = ""
local sys1 = tiny.system()
local sys2 = tiny.system()
function sys1:preWrap(dt)
str = str .. "<"
end
function sys2:preWrap(dt)
str = str .. "{"
end
function sys1:postWrap(dt)
str = str .. ">"
end
function sys2:postWrap(dt)
str = str .. "}"
end
world:add(sys1, sys2)
world:update(1)
assert.equals(str, "{<>}")
end)
end)
it("Doesn't pollute the global namespace", function()
assert.are.same(_G, GLOBALS)
end) end)
end) end)
+378 -196
View File
@@ -1,5 +1,5 @@
--[[ --[[
Copyright (c) 2015 Calvin Rose Copyright (c) 2016 Calvin Rose
Permission is hereby granted, free of charge, to any person obtaining a copy of Permission is hereby granted, free of charge, to any person obtaining a copy of
this software and associated documentation files (the "Software"), to deal in this software and associated documentation files (the "Software"), to deal in
@@ -22,14 +22,13 @@ CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
--- @module tiny-ecs --- @module tiny-ecs
-- @author Calvin Rose -- @author Calvin Rose
-- @license MIT -- @license MIT
-- @copyright 2015 -- @copyright 2016
local tiny = { _VERSION = "1.1-7" } local tiny = {}
-- Local versions of standard lua functions -- Local versions of standard lua functions
local tinsert = table.insert local tinsert = table.insert
local tremove = table.remove local tremove = table.remove
local tsort = table.sort local tsort = table.sort
local pairs = pairs
local setmetatable = setmetatable local setmetatable = setmetatable
local type = type local type = type
local select = select local select = select
@@ -85,88 +84,125 @@ local tiny_remove
-- --
-- @section Filter -- @section Filter
-- A helper function to compile filters.
local filterJoin
-- A helper function to filters from string
local filterBuildString
do
local loadstring = loadstring or load
local function getchr(c)
return "\\" .. c:byte()
end
local function make_safe(text)
return ("%q"):format(text):gsub('\n', 'n'):gsub("[\128-\255]", getchr)
end
local function filterJoinRaw(prefix, seperator, ...)
local accum = {}
local build = {}
for i = 1, select('#', ...) do
local item = select(i, ...)
if type(item) == 'string' then
accum[#accum + 1] = ("(e[%s] ~= nil)"):format(make_safe(item))
elseif type(item) == 'function' then
build[#build + 1] = ('local subfilter_%d_ = select(%d, ...)')
:format(i, i)
accum[#accum + 1] = ('(subfilter_%d_(system, e))'):format(i)
else
error 'Filter token must be a string or a filter function.'
end
end
local source = ('%s\nreturn function(system, e) return %s(%s) end')
:format(
table.concat(build, '\n'),
prefix,
table.concat(accum, seperator))
local loader, err = loadstring(source)
if err then error(err) end
return loader(...)
end
function filterJoin(...)
local state, value = pcall(filterJoinRaw, ...)
if state then return value else return nil, value end
end
local function buildPart(str)
local accum = {}
local subParts = {}
str = str:gsub('%b()', function(p)
subParts[#subParts + 1] = buildPart(p:sub(2, -2))
return ('\255%d'):format(#subParts)
end)
for invert, part, sep in str:gmatch('(%!?)([^%|%&%!]+)([%|%&]?)') do
if part:match('^\255%d+$') then
local partIndex = tonumber(part:match(part:sub(2)))
accum[#accum + 1] = ('%s(%s)')
:format(invert == '' and '' or 'not', subParts[partIndex])
else
accum[#accum + 1] = ("(e[%s] %s nil)")
:format(make_safe(part), invert == '' and '~=' or '==')
end
if sep ~= '' then
accum[#accum + 1] = (sep == '|' and ' or ' or ' and ')
end
end
return table.concat(accum)
end
function filterBuildString(str)
local source = ("return function(_, e) return %s end")
:format(buildPart(str))
local loader, err = loadstring(source)
if err then
error(err)
end
return loader()
end
end
--- Makes a Filter that selects Entities with all specified Components and --- Makes a Filter that selects Entities with all specified Components and
-- Filters. -- Filters.
function tiny.requireAll(...) function tiny.requireAll(...)
local components = {...} return filterJoin('', ' and ', ...)
local len = #components
return function(system, e)
local c
for i = 1, len do
c = components[i]
if type(c) == 'function' then
if not c(system, e) then
return false
end
elseif e[c] == nil then
return false
end
end
return true
end
end end
--- Makes a Filter that selects Entities with at least one of the specified --- Makes a Filter that selects Entities with at least one of the specified
-- Components and Filters. -- Components and Filters.
function tiny.requireAny(...) function tiny.requireAny(...)
local components = {...} return filterJoin('', ' or ', ...)
local len = #components
return function(system, e)
local c
for i = 1, len do
c = components[i]
if type(c) == 'function' then
if c(system, e) then
return true
end
elseif e[c] ~= nil then
return true
end
end
return false
end
end end
--- Makes a Filter that rejects Entities with all specified Components and --- Makes a Filter that rejects Entities with all specified Components and
-- Filters, and selects all other Entities. -- Filters, and selects all other Entities.
function tiny.rejectAll(...) function tiny.rejectAll(...)
local components = {...} return filterJoin('not', ' and ', ...)
local len = #components
return function(system, e)
local c
for i = 1, len do
c = components[i]
if type(c) == 'function' then
if not c(system, e) then
return true
end
elseif e[c] == nil then
return true
end
end
return false
end
end end
--- Makes a Filter that rejects Entities with at least one of the specified --- Makes a Filter that rejects Entities with at least one of the specified
-- Components and Filters, and selects all other Entities. -- Components and Filters, and selects all other Entities.
function tiny.rejectAny(...) function tiny.rejectAny(...)
local components = {...} return filterJoin('not', ' or ', ...)
local len = #components end
return function(system, e)
local c --- Makes a Filter from a string. Syntax of `pattern` is as follows.
for i = 1, len do --
c = components[i] -- * Tokens are alphanumeric strings including underscores.
if type(c) == 'function' then -- * Tokens can be separated by |, &, or surrounded by parentheses.
if c(system, e) then -- * Tokens can be prefixed with !, and are then inverted.
return false --
end -- Examples are best:
elseif e[c] ~= nil then -- 'a|b|c' - Matches entities with an 'a' OR 'b' OR 'c'.
return false -- 'a&!b&c' - Matches entities with an 'a' AND NOT 'b' AND 'c'.
end -- 'a|(b&c&d)|e - Matches 'a' OR ('b' AND 'c' AND 'd') OR 'e'
end -- @param pattern
return true function tiny.filter(pattern)
end local state, value = pcall(filterBuildString, pattern)
if state then return value else return nil, value end
end end
--- System functions. --- System functions.
@@ -187,6 +223,23 @@ end
-- from the System. -- from the System.
-- * `function system:onModify(dt)` - Called when the System is modified by -- * `function system:onModify(dt)` - Called when the System is modified by
-- adding or removing Entities from the System. -- adding or removing Entities from the System.
-- * `function system:onAddToWorld(world)` - Called when the System is added
-- to the World, before any entities are added to the system.
-- * `function system:onRemoveFromWorld(world)` - Called when the System is
-- removed from the world, after all Entities are removed from the System.
-- * `function system:preWrap(dt)` - Called on each system before update is
-- called on any system.
-- * `function system:postWrap(dt) - Called on each system in reverse order
-- after update is called on each system. The idea behind `preWrap` and
-- `postWrap` is to allow for systems that modify the behavior of other systems.
-- Say there is a DrawingSystem, which draws sprites to the screen, and a
-- PostProcessingSystem, that adds some blur and bloom effects. In the preWrap
-- method of the PostProcessingSystem, the System could set the drawing target
-- for the DrawingSystem to a special buffer instead the screen. In the postWrap
-- method, the PostProcessingSystem could then modify the buffer and render it
-- to the screen. In this setup, the PostProcessingSystem would be added to the
-- World after the drawingSystem (A similar but less flexible behavior could
-- be accomplished with a single custom update function in the DrawingSystem).
-- --
-- For Filters, it is convenient to use `tiny.requireAll` or `tiny.requireAny`, -- For Filters, it is convenient to use `tiny.requireAll` or `tiny.requireAny`,
-- but one can write their own filters as well. Set the Filter of a System like -- but one can write their own filters as well. Set the Filter of a System like
@@ -222,6 +275,14 @@ end
-- in the next update, if it has one. This is usually managed by tiny-ecs, so -- in the next update, if it has one. This is usually managed by tiny-ecs, so
-- users should mostly ignore this, too. -- users should mostly ignore this, too.
-- --
-- There is another option to (hopefully) increase performance in systems that
-- have items added to or removed from them often, and have lots of entities in
-- them. Setting the `nocache' field of the system might improve performance.
-- It is still experimental. There are some restriction to systems without
-- caching, however. * There is no `entities` table. * Callbacks such onAdd,
-- onRemove, and onModify will never be called * Noncached systems cannot be
-- sorted (There is no entities list to sort).
--
-- @section System -- @section System
-- Use an empty table as a key for identifying Systems. Any table that contains -- Use an empty table as a key for identifying Systems. Any table that contains
@@ -235,21 +296,31 @@ end
-- Update function for all Processing Systems. -- Update function for all Processing Systems.
local function processingSystemUpdate(system, dt) local function processingSystemUpdate(system, dt)
local entities = system.entities
local preProcess = system.preProcess local preProcess = system.preProcess
local process = system.process local process = system.process
local postProcess = system.postProcess local postProcess = system.postProcess
local entity
if preProcess then if preProcess then
preProcess(system, dt) preProcess(system, dt)
end end
if process then if process then
local len = #entities if system.nocache then
for i = 1, len do local entities = system.world.entityList
entity = entities[i] local filter = system.filter
process(system, entity, dt) if filter then
for i = 1, #entities do
local entity = entities[i]
if filter(system, entity) then
process(system, entity, dt)
end
end
end
else
local entities = system.entities
for i = 1, #entities do
process(system, entities[i], dt)
end
end end
end end
@@ -258,7 +329,7 @@ local function processingSystemUpdate(system, dt)
end end
end end
-- Sorts Systems by a function system.sort(entity1, entity2) on modify. -- Sorts Systems by a function system.sortDelegate(entity1, entity2) on modify.
local function sortedSystemOnModify(system, dt) local function sortedSystemOnModify(system, dt)
local entities = system.entities local entities = system.entities
local indices = system.indices local indices = system.indices
@@ -272,8 +343,7 @@ local function sortedSystemOnModify(system, dt)
end end
tsort(entities, sortDelegate) tsort(entities, sortDelegate)
for i = 1, #entities do for i = 1, #entities do
local entity = entities[i] indices[entities[i]] = i
indices[entity] = i
end end
end end
@@ -290,9 +360,9 @@ end
-- Processing Systems have three extra callbacks besides those inheritted from -- Processing Systems have three extra callbacks besides those inheritted from
-- vanilla Systems. -- vanilla Systems.
-- --
-- function system:preProcess(entities, dt) -- Called before iteration. -- function system:preProcess(dt) -- Called before iteration.
-- function system:process(entities, dt) -- Process each entity. -- function system:process(entity, dt) -- Process each entity.
-- function system:postProcess(entity, dt) -- Called after iteration. -- function system:postProcess(dt) -- Called after iteration.
-- --
-- Processing Systems have their own `update` method, so don't implement a -- Processing Systems have their own `update` method, so don't implement a
-- a custom `update` callback for Processing Systems. -- a custom `update` callback for Processing Systems.
@@ -348,7 +418,7 @@ local worldMetaTable
-- Can optionally add default Systems and Entities. Returns the new World along -- Can optionally add default Systems and Entities. Returns the new World along
-- with default Entities and Systems. -- with default Entities and Systems.
function tiny.world(...) function tiny.world(...)
local ret = { local ret = setmetatable({
-- List of Entities to add -- List of Entities to add
entitiesToAdd = {}, entitiesToAdd = {},
@@ -356,6 +426,9 @@ function tiny.world(...)
-- List of Entities to remove -- List of Entities to remove
entitiesToRemove = {}, entitiesToRemove = {},
-- List of Entities to change
entitiesToChange = {},
-- List of Entities to add -- List of Entities to add
systemsToAdd = {}, systemsToAdd = {},
@@ -365,28 +438,33 @@ function tiny.world(...)
-- Set of Entities -- Set of Entities
entities = {}, entities = {},
-- List of Entities
entityList = {},
-- Number of Entities in World -- Number of Entities in World
entityCount = 0, entityCount = 0,
-- List of Systems -- List of Systems
systems = {} systems = {}
} }, worldMetaTable)
tiny_add(ret, ...) tiny_add(ret, ...)
tiny_manageSystems(ret) tiny_manageSystems(ret)
tiny_manageEntities(ret) tiny_manageEntities(ret)
return setmetatable(ret, worldMetaTable), ... return ret, ...
end end
--- Adds an Entity to the world. --- Adds an Entity to the world.
-- Also call this on Entities that have changed Components such that they -- Also call this on Entities that have changed Components such that they
-- match different Filters. Returns the Entity. -- match different Filters. Returns the Entity.
function tiny.addEntity(world, entity) function tiny.addEntity(world, entity)
local e2a = world.entitiesToAdd
e2a[#e2a + 1] = entity
if world.entities[entity] then if world.entities[entity] then
tiny_removeEntity(world, entity) local e2c = world.entitiesToChange
e2c[#e2c + 1] = entity
else
local e2a = world.entitiesToAdd
e2a[#e2a + 1] = entity
end end
return entity return entity
end end
@@ -394,8 +472,10 @@ tiny_addEntity = tiny.addEntity
--- Adds a System to the world. Returns the System. --- Adds a System to the world. Returns the System.
function tiny.addSystem(world, system) function tiny.addSystem(world, system)
assert(system.world == nil, "System already belongs to a World.")
local s2a = world.systemsToAdd local s2a = world.systemsToAdd
s2a[#s2a + 1] = system s2a[#s2a + 1] = system
system.world = world
return system return system
end end
tiny_addSystem = tiny.addSystem tiny_addSystem = tiny.addSystem
@@ -403,9 +483,8 @@ tiny_addSystem = tiny.addSystem
--- Shortcut for adding multiple Entities and Systems to the World. Returns all --- Shortcut for adding multiple Entities and Systems to the World. Returns all
-- added Entities and Systems. -- added Entities and Systems.
function tiny.add(world, ...) function tiny.add(world, ...)
local obj
for i = 1, select("#", ...) do for i = 1, select("#", ...) do
obj = select(i, ...) local obj = select(i, ...)
if obj then if obj then
if isSystem(obj) then if isSystem(obj) then
tiny_addSystem(world, obj) tiny_addSystem(world, obj)
@@ -428,6 +507,7 @@ tiny_removeEntity = tiny.removeEntity
--- Removes a System from the world. Returns the System. --- Removes a System from the world. Returns the System.
function tiny.removeSystem(world, system) function tiny.removeSystem(world, system)
assert(system.world == world, "System does not belong to this World.")
local s2r = world.systemsToRemove local s2r = world.systemsToRemove
s2r[#s2r + 1] = system s2r[#s2r + 1] = system
return system return system
@@ -437,14 +517,13 @@ tiny_removeSystem = tiny.removeSystem
--- Shortcut for removing multiple Entities and Systems from the World. Returns --- Shortcut for removing multiple Entities and Systems from the World. Returns
-- all removed Systems and Entities -- all removed Systems and Entities
function tiny.remove(world, ...) function tiny.remove(world, ...)
local obj
for i = 1, select("#", ...) do for i = 1, select("#", ...) do
obj = select(i, ...) local obj = select(i, ...)
if obj then if obj then
if isSystem(obj) then if isSystem(obj) then
tiny_removeSystem(world, obj) tiny_removeSystem(world, obj)
else -- Assume obj is an Entity else -- Assume obj is an Entity
tiny_removeEntity(world, obj) tiny_removeEntity(world, obj)
end end
end end
end end
@@ -454,68 +533,79 @@ tiny_remove = tiny.remove
-- Adds and removes Systems that have been marked from the World. -- Adds and removes Systems that have been marked from the World.
function tiny_manageSystems(world) function tiny_manageSystems(world)
local s2a, s2r = world.systemsToAdd, world.systemsToRemove local s2a, s2r = world.systemsToAdd, world.systemsToRemove
-- Early exit -- Early exit
if #s2a == 0 and #s2r == 0 then if #s2a == 0 and #s2r == 0 then
return return
end end
local entities = world.entities world.systemsToAdd = {}
local systems = world.systems world.systemsToRemove = {}
local system, index, filter
local entityList, entityIndices, entityIndex, onRemove, onAdd
-- Remove Systems local worldEntityList = world.entityList
for i = 1, #s2r do local systems = world.systems
system = s2r[i]
index = system.index -- Remove Systems
if system.world == world then for i = 1, #s2r do
onRemove = system.onRemove local system = s2r[i]
if onRemove then local index = system.index
entityList = system.entities local onRemove = system.onRemove
for j = 1, #entityList do if onRemove and not system.nocache then
onRemove(system, entityList[j]) local entityList = system.entities
end for j = 1, #entityList do
end onRemove(system, entityList[j])
tremove(systems, index)
for j = index, #systems do
systems[j].index = j
end
end end
s2r[i] = nil
-- Clean up System
system.world = nil
system.entities = nil
system.indices = nil
system.index = nil
end end
tremove(systems, index)
for j = index, #systems do
systems[j].index = j
end
local onRemoveFromWorld = system.onRemoveFromWorld
if onRemoveFromWorld then
onRemoveFromWorld(system, world)
end
s2r[i] = nil
-- Add Systems -- Clean up System
for i = 1, #s2a do system.world = nil
system = s2a[i] system.entities = nil
if systems[system.index] ~= system then system.indices = nil
entityList = {} system.index = nil
entityIndices = {} end
system.entities = entityList
system.indices = entityIndices
if system.active == nil then
system.active = true
end
system.modified = true
system.world = world
index = #systems + 1
system.index = index
systems[index] = system
-- Try to add Entities -- Add Systems
onAdd = system.onAdd for i = 1, #s2a do
filter = system.filter local system = s2a[i]
if systems[system.index or 0] ~= system then
if not system.nocache then
system.entities = {}
system.indices = {}
end
if system.active == nil then
system.active = true
end
system.modified = true
system.world = world
local index = #systems + 1
system.index = index
systems[index] = system
local onAddToWorld = system.onAddToWorld
if onAddToWorld then
onAddToWorld(system, world)
end
-- Try to add Entities
if not system.nocache then
local entityList = system.entities
local entityIndices = system.indices
local onAdd = system.onAdd
local filter = system.filter
if filter then if filter then
for entity in pairs(entities) do for j = 1, #worldEntityList do
local entity = worldEntityList[j]
if filter(system, entity) then if filter(system, entity) then
entityIndex = #entityList + 1 local entityIndex = #entityList + 1
entityList[entityIndex] = entity entityList[entityIndex] = entity
entityIndices[entity] = entityIndex entityIndices[entity] = entityIndex
if onAdd then if onAdd then
@@ -525,82 +615,135 @@ function tiny_manageSystems(world)
end end
end end
end end
s2a[i] = nil
end end
s2a[i] = nil
end
end end
-- Adds and removes Entities that have been marked. -- Adds, removes, and changes Entities that have been marked.
function tiny_manageEntities(world) function tiny_manageEntities(world)
local e2a, e2r = world.entitiesToAdd, world.entitiesToRemove
local e2a = world.entitiesToAdd
local e2r = world.entitiesToRemove
local e2c = world.entitiesToChange
-- Early exit -- Early exit
if #e2a == 0 and #e2r == 0 then if #e2a == 0 and #e2r == 0 and #e2c == 0 then
return return
end end
world.entitiesToChange = {}
world.entitiesToAdd = {}
world.entitiesToRemove = {}
local entities = world.entities local entities = world.entities
local entityList = world.entityList
local systems = world.systems local systems = world.systems
local entityCount = world.entityCount local entityCount = world.entityCount
local entity, system, index
local onRemove, onAdd, ses, seis, filter, tmpEntity -- Change Entities
for i = 1, #e2c do
local entity = e2c[i]
if entities[entity] then
for j = 1, #systems do
local system = systems[j]
if not system.nocache then
local ses = system.entities
local seis = system.indices
local index = seis[entity]
local filter = system.filter
if filter and filter(system, entity) then
if not index then
system.modified = true
index = #ses + 1
ses[index] = entity
seis[entity] = index
local onAdd = system.onAdd
if onAdd then
onAdd(system, entity)
end
end
elseif index then
system.modified = true
local tmpEntity = ses[#ses]
ses[index] = tmpEntity
seis[tmpEntity] = index
seis[entity] = nil
ses[#ses] = nil
local onRemove = system.onRemove
if onRemove then
onRemove(system, entity)
end
end
end
end
end
e2c[i] = nil
end
-- Remove Entities -- Remove Entities
for i = 1, #e2r do for i = 1, #e2r do
entity = e2r[i] local entity = e2r[i]
if entities[entity] then e2r[i] = nil
local listIndex = entities[entity]
if listIndex then
-- Remove Entity from world state
local lastEntity = entityList[#entityList]
entities[lastEntity] = listIndex
entities[entity] = nil entities[entity] = nil
entityList[listIndex] = lastEntity
entityList[#entityList] = nil
entityCount = entityCount - 1 entityCount = entityCount - 1
-- Remove from cached systems
for j = 1, #systems do for j = 1, #systems do
system = systems[j] local system = systems[j]
ses = system.entities if not system.nocache then
seis = system.indices local ses = system.entities
index = seis[entity] local seis = system.indices
local index = seis[entity]
if index then if index then
system.modified = true system.modified = true
tmpEntity = ses[#ses] local tmpEntity = ses[#ses]
ses[index] = tmpEntity ses[index] = tmpEntity
seis[tmpEntity] = index seis[tmpEntity] = index
seis[entity] = nil seis[entity] = nil
ses[#ses] = nil ses[#ses] = nil
onRemove = system.onRemove local onRemove = system.onRemove
if onRemove then if onRemove then
onRemove(system, entity) onRemove(system, entity)
end
end end
end end
end end
end end
e2r[i] = nil
end end
-- Add Entities -- Add Entities
for i = 1, #e2a do for i = 1, #e2a do
entity = e2a[i] local entity = e2a[i]
if not entities[entity] then if not entities[entity] then
entities[entity] = true local listIndex = #entityList + 1
entities[entity] = listIndex
entityList[listIndex] = entity
entityCount = entityCount + 1 entityCount = entityCount + 1
for j = 1, #systems do for j = 1, #systems do
system = systems[j] local system = systems[j]
ses = system.entities if not system.nocache then
seis = system.indices local ses = system.entities
filter = system.filter local seis = system.indices
if filter and filter(system, entity) then local filter = system.filter
system.modified = true if filter and filter(system, entity) then
index = #ses + 1 system.modified = true
ses[index] = entity local index = #ses + 1
seis[entity] = index ses[index] = entity
onAdd = system.onAdd seis[entity] = index
if onAdd then local onAdd = system.onAdd
onAdd(system, entity) if onAdd then
onAdd(system, entity)
end
end end
end end
end end
end end
e2a[i] = nil e2a[i] = nil
end end
@@ -615,6 +758,17 @@ end
function tiny.refresh(world) function tiny.refresh(world)
tiny_manageSystems(world) tiny_manageSystems(world)
tiny_manageEntities(world) tiny_manageEntities(world)
local systems = world.systems
for i = 1, #systems do
local system = systems[i]
if system.active then
local onModify = system.onModify
if onModify and system.modified then
onModify(system, 0)
end
system.modified = false
end
end
end end
--- Updates the World by dt (delta time). Takes an optional parameter, `filter`, --- Updates the World by dt (delta time). Takes an optional parameter, `filter`,
@@ -627,23 +781,32 @@ function tiny.update(world, dt, filter)
tiny_manageEntities(world) tiny_manageEntities(world)
local systems = world.systems local systems = world.systems
local system, update, interval, onModify
-- Iterate through Systems IN REVERSE ORDER
for i = #systems, 1, -1 do
local system = systems[i]
local preWrap = system.preWrap
if preWrap and system.active and
((not filter) or filter(world, system)) then
preWrap(system, dt)
end
end
-- Iterate through Systems IN ORDER -- Iterate through Systems IN ORDER
for i = 1, #systems do for i = 1, #systems do
system = systems[i] local system = systems[i]
if system.active and ((not filter) or filter(world, system)) then if system.active and ((not filter) or filter(world, system)) then
-- Call the modify callback on Systems that have been modified. -- Call the modify callback on Systems that have been modified.
onModify = system.onModify local onModify = system.onModify
if onModify and system.modified then if onModify and system.modified then
onModify(system, dt) onModify(system, dt)
end end
-- Update Systems that have an update method (most Systems) -- Update Systems that have an update method (most Systems)
update = system.update local update = system.update
if update then if update then
interval = system.interval local interval = system.interval
if interval then if interval then
local bufferedTime = (system.bufferedTime or 0) + dt local bufferedTime = (system.bufferedTime or 0) + dt
while bufferedTime >= interval do while bufferedTime >= interval do
@@ -661,12 +824,24 @@ function tiny.update(world, dt, filter)
system.modified = false system.modified = false
end end
end end
-- Iterate through Systems IN ORDER AGAIN
for i = 1, #systems do
local system = systems[i]
local postWrap = system.postWrap
if postWrap and system.active and
((not filter) or filter(world, system)) then
postWrap(system, dt)
end
end
end end
--- Removes all Entities from the World. --- Removes all Entities from the World.
function tiny.clearEntities(world) function tiny.clearEntities(world)
for e in pairs(world.entities) do local el = world.entityList
tiny_removeEntity(world, e) for i = 1, #el do
tiny_removeEntity(world, el[i])
end end
end end
@@ -701,6 +876,10 @@ function tiny.setSystemIndex(world, system, index)
local oldIndex = system.index local oldIndex = system.index
local systems = world.systems local systems = world.systems
if index < 0 then
index = tiny.getSystemCount(world) + 1 + index
end
tremove(systems, oldIndex) tremove(systems, oldIndex)
tinsert(systems, index, system) tinsert(systems, index, system)
@@ -728,7 +907,10 @@ worldMetaTable = {
getSystemCount = tiny.getSystemCount, getSystemCount = tiny.getSystemCount,
getSystemIndex = tiny.getSystemIndex, getSystemIndex = tiny.getSystemIndex,
setSystemIndex = tiny.setSystemIndex setSystemIndex = tiny.setSystemIndex
} },
__tostring = function(self)
return "<tiny-ecs_World>"
end
} }
return tiny return tiny