mirror of
https://github.com/bakpakin/tiny-ecs.git
synced 2026-07-22 07:56:52 -06:00
Compare commits
21 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
5997f949cd | ||
|
|
ea6009a8d2 | ||
|
|
7da4efb7df | ||
|
|
9bc366a2fb | ||
|
|
80b7b48703 | ||
|
|
0488bff1d9 | ||
|
|
ee192d94af | ||
|
|
a518e15e44 | ||
|
|
37c2c49300 | ||
|
|
195c882bbd | ||
|
|
29a4a02f30 | ||
|
|
df5c84033b | ||
|
|
d9c296dae6 | ||
|
|
08e5f13d85 | ||
|
|
cbf71d2cb2 | ||
|
|
93a19d93c8 | ||
|
|
4148855233 | ||
|
|
27f881444a | ||
|
|
3b4bd9920b | ||
|
|
206361ca38 | ||
|
|
29158282bd |
+1
-1
@@ -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:
|
||||||
|
|
||||||
|
|||||||
@@ -1,28 +1,26 @@
|
|||||||
# tiny-ecs #
|
# tiny-ecs #
|
||||||
|
|
||||||
[](https://travis-ci.org/bakpakin/tiny-ecs)
|
[](https://travis-ci.org/bakpakin/tiny-ecs)[](LICENSE)
|
||||||
|
|
||||||
[](LICENSE)
|
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
|
||||||
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
|
|
||||||
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.
|
||||||
@@ -39,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.
|
||||||
|
|
||||||
@@ -51,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 = {
|
||||||
@@ -70,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
|
||||||
@@ -80,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
|
||||||
|
|||||||
@@ -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
|
||||||
|
|||||||
@@ -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')
|
||||||
@@ -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.",
|
||||||
|
|||||||
@@ -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.",
|
||||||
|
|||||||
@@ -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.",
|
||||||
|
|||||||
@@ -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.",
|
||||||
|
|||||||
@@ -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.",
|
||||||
|
|||||||
@@ -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.",
|
||||||
|
|||||||
@@ -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.",
|
||||||
|
|||||||
@@ -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.",
|
||||||
|
|||||||
@@ -2,7 +2,7 @@ package = "tiny-ecs"
|
|||||||
version = "1.2-1"
|
version = "1.2-1"
|
||||||
source = {
|
source = {
|
||||||
url = "git://github.com/bakpakin/tiny-ecs",
|
url = "git://github.com/bakpakin/tiny-ecs",
|
||||||
tag = "1.2-1"
|
tag = version
|
||||||
}
|
}
|
||||||
description = {
|
description = {
|
||||||
summary = "Entity Component System for Lua.",
|
summary = "Entity Component System for Lua.",
|
||||||
|
|||||||
@@ -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"
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -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"
|
||||||
|
}
|
||||||
|
}
|
||||||
+68
-2
@@ -90,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()
|
||||||
@@ -190,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())
|
||||||
@@ -227,17 +272,38 @@ 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)
|
end)
|
||||||
|
|
||||||
it("Doesn't pollute the global namespace", function()
|
it("Doesn't pollute the global namespace", function()
|
||||||
|
|||||||
@@ -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.2-1" }
|
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.
|
||||||
@@ -191,6 +227,19 @@ end
|
|||||||
-- to the World, before any entities are added to the system.
|
-- to the World, before any entities are added to the system.
|
||||||
-- * `function system:onRemoveFromWorld(world)` - Called when the System is
|
-- * `function system:onRemoveFromWorld(world)` - Called when the System is
|
||||||
-- removed from the world, after all Entities are removed from the System.
|
-- 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
|
||||||
@@ -226,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
|
||||||
@@ -248,11 +305,22 @@ local function processingSystemUpdate(system, dt)
|
|||||||
end
|
end
|
||||||
|
|
||||||
if process then
|
if process then
|
||||||
local entities = system.entities
|
if system.nocache then
|
||||||
local len = #entities
|
local entities = system.world.entityList
|
||||||
for i = 1, len do
|
local filter = system.filter
|
||||||
local entity = entities[i]
|
if filter then
|
||||||
process(system, entity, dt)
|
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
|
||||||
|
|
||||||
@@ -261,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
|
||||||
@@ -275,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
|
||||||
|
|
||||||
@@ -371,6 +438,9 @@ 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,
|
||||||
|
|
||||||
@@ -473,7 +543,7 @@ function tiny_manageSystems(world)
|
|||||||
world.systemsToAdd = {}
|
world.systemsToAdd = {}
|
||||||
world.systemsToRemove = {}
|
world.systemsToRemove = {}
|
||||||
|
|
||||||
local entities = world.entities
|
local worldEntityList = world.entityList
|
||||||
local systems = world.systems
|
local systems = world.systems
|
||||||
|
|
||||||
-- Remove Systems
|
-- Remove Systems
|
||||||
@@ -481,7 +551,7 @@ function tiny_manageSystems(world)
|
|||||||
local system = s2r[i]
|
local system = s2r[i]
|
||||||
local index = system.index
|
local index = system.index
|
||||||
local onRemove = system.onRemove
|
local onRemove = system.onRemove
|
||||||
if onRemove then
|
if onRemove and not system.nocache then
|
||||||
local entityList = system.entities
|
local entityList = system.entities
|
||||||
for j = 1, #entityList do
|
for j = 1, #entityList do
|
||||||
onRemove(system, entityList[j])
|
onRemove(system, entityList[j])
|
||||||
@@ -507,11 +577,11 @@ function tiny_manageSystems(world)
|
|||||||
-- Add Systems
|
-- Add Systems
|
||||||
for i = 1, #s2a do
|
for i = 1, #s2a do
|
||||||
local system = s2a[i]
|
local system = s2a[i]
|
||||||
if systems[system.index] ~= system then
|
if systems[system.index or 0] ~= system then
|
||||||
local entityList = {}
|
if not system.nocache then
|
||||||
local entityIndices = {}
|
system.entities = {}
|
||||||
system.entities = entityList
|
system.indices = {}
|
||||||
system.indices = entityIndices
|
end
|
||||||
if system.active == nil then
|
if system.active == nil then
|
||||||
system.active = true
|
system.active = true
|
||||||
end
|
end
|
||||||
@@ -526,16 +596,21 @@ function tiny_manageSystems(world)
|
|||||||
end
|
end
|
||||||
|
|
||||||
-- Try to add Entities
|
-- Try to add Entities
|
||||||
local onAdd = system.onAdd
|
if not system.nocache then
|
||||||
local filter = system.filter
|
local entityList = system.entities
|
||||||
if filter then
|
local entityIndices = system.indices
|
||||||
for entity in pairs(entities) do
|
local onAdd = system.onAdd
|
||||||
if filter(system, entity) then
|
local filter = system.filter
|
||||||
local entityIndex = #entityList + 1
|
if filter then
|
||||||
entityList[entityIndex] = entity
|
for j = 1, #worldEntityList do
|
||||||
entityIndices[entity] = entityIndex
|
local entity = worldEntityList[j]
|
||||||
if onAdd then
|
if filter(system, entity) then
|
||||||
onAdd(system, entity)
|
local entityIndex = #entityList + 1
|
||||||
|
entityList[entityIndex] = entity
|
||||||
|
entityIndices[entity] = entityIndex
|
||||||
|
if onAdd then
|
||||||
|
onAdd(system, entity)
|
||||||
|
end
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
@@ -562,6 +637,7 @@ function tiny_manageEntities(world)
|
|||||||
world.entitiesToRemove = {}
|
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
|
||||||
|
|
||||||
@@ -571,31 +647,33 @@ function tiny_manageEntities(world)
|
|||||||
if entities[entity] then
|
if entities[entity] then
|
||||||
for j = 1, #systems do
|
for j = 1, #systems do
|
||||||
local system = systems[j]
|
local system = systems[j]
|
||||||
local ses = system.entities
|
if not system.nocache then
|
||||||
local seis = system.indices
|
local ses = system.entities
|
||||||
local index = seis[entity]
|
local seis = system.indices
|
||||||
local filter = system.filter
|
local index = seis[entity]
|
||||||
if filter and filter(system, entity) then
|
local filter = system.filter
|
||||||
if not index then
|
if filter and filter(system, entity) then
|
||||||
system.modified = true
|
if not index then
|
||||||
index = #ses + 1
|
system.modified = true
|
||||||
ses[index] = entity
|
index = #ses + 1
|
||||||
seis[entity] = index
|
ses[index] = entity
|
||||||
local onAdd = system.onAdd
|
seis[entity] = index
|
||||||
if onAdd then
|
local onAdd = system.onAdd
|
||||||
onAdd(system, entity)
|
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
|
|
||||||
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
|
end
|
||||||
@@ -606,50 +684,63 @@ function tiny_manageEntities(world)
|
|||||||
-- Remove Entities
|
-- Remove Entities
|
||||||
for i = 1, #e2r do
|
for i = 1, #e2r do
|
||||||
local 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
|
||||||
local system = systems[j]
|
local system = systems[j]
|
||||||
local ses = system.entities
|
if not system.nocache then
|
||||||
local seis = system.indices
|
local ses = system.entities
|
||||||
local index = seis[entity]
|
local seis = system.indices
|
||||||
if index then
|
local index = seis[entity]
|
||||||
system.modified = true
|
if index then
|
||||||
local tmpEntity = ses[#ses]
|
system.modified = true
|
||||||
ses[index] = tmpEntity
|
local tmpEntity = ses[#ses]
|
||||||
seis[tmpEntity] = index
|
ses[index] = tmpEntity
|
||||||
seis[entity] = nil
|
seis[tmpEntity] = index
|
||||||
ses[#ses] = nil
|
seis[entity] = nil
|
||||||
local onRemove = system.onRemove
|
ses[#ses] = nil
|
||||||
if onRemove then
|
local onRemove = system.onRemove
|
||||||
onRemove(system, entity)
|
if onRemove then
|
||||||
|
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
|
||||||
local 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
|
||||||
local system = systems[j]
|
local system = systems[j]
|
||||||
local ses = system.entities
|
if not system.nocache then
|
||||||
local seis = system.indices
|
local ses = system.entities
|
||||||
local 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
|
||||||
local index = #ses + 1
|
system.modified = true
|
||||||
ses[index] = entity
|
local index = #ses + 1
|
||||||
seis[entity] = index
|
ses[index] = entity
|
||||||
local 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
|
||||||
@@ -667,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`,
|
||||||
@@ -680,6 +782,16 @@ function tiny.update(world, dt, filter)
|
|||||||
|
|
||||||
local systems = world.systems
|
local systems = world.systems
|
||||||
|
|
||||||
|
-- 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
|
||||||
local system = systems[i]
|
local system = systems[i]
|
||||||
@@ -712,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
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user