6 Commits

Author SHA1 Message Date
bakpakin
8a3c22e74f Add new rockspec. 2016-08-10 19:45:58 -04:00
bakpakin
a0fa0904f6 Update filer documentation to be more explicit. 2016-08-10 19:36:20 -04:00
Calvin Rose
80bb6b8d31 Remove world.entityCount and world.entityList. 2016-08-10 17:23:48 -04:00
bakpakin
83d806011b Combine the 'add entities' procedure in manage_entities with 'change
entities'
2016-08-10 07:23:05 -04:00
Calvin Rose
d720d361e6 Remove redundant non-nil check 2016-07-13 09:43:36 -04:00
Calvin Rose
d94b178670 Make source pass luacheck. Remove tiny.getSystemIndex(). 2016-07-05 17:15:18 -04:00
2 changed files with 86 additions and 117 deletions
+24
View File
@@ -0,0 +1,24 @@
package = "tiny-ecs"
version = "1.3-3"
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"
}
}
+62 -117
View File
@@ -41,12 +41,13 @@ local tiny_addSystem
local tiny_add local tiny_add
local tiny_removeEntity local tiny_removeEntity
local tiny_removeSystem local tiny_removeSystem
local tiny_remove
--- 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
@@ -330,7 +331,7 @@ local function processingSystemUpdate(system, dt)
end end
-- Sorts Systems by a function system.sortDelegate(entity1, entity2) on modify. -- Sorts Systems by a function system.sortDelegate(entity1, entity2) on modify.
local function sortedSystemOnModify(system, dt) local function sortedSystemOnModify(system)
local entities = system.entities local entities = system.entities
local indices = system.indices local indices = system.indices
local sortDelegate = system.sortDelegate local sortDelegate = system.sortDelegate
@@ -420,9 +421,6 @@ local worldMetaTable
function tiny.world(...) function tiny.world(...)
local ret = setmetatable({ local ret = setmetatable({
-- List of Entities to add
entitiesToAdd = {},
-- List of Entities to remove -- List of Entities to remove
entitiesToRemove = {}, entitiesToRemove = {},
@@ -438,14 +436,9 @@ function tiny.world(...)
-- Set of Entities -- Set of Entities
entities = {}, entities = {},
-- List of Entities
entityList = {},
-- Number of Entities in World
entityCount = 0,
-- List of Systems -- List of Systems
systems = {} systems = {}
}, worldMetaTable) }, worldMetaTable)
tiny_add(ret, ...) tiny_add(ret, ...)
@@ -459,13 +452,8 @@ end
-- 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)
if world.entities[entity] then local e2c = world.entitiesToChange
local e2c = world.entitiesToChange e2c[#e2c + 1] = entity
e2c[#e2c + 1] = entity
else
local e2a = world.entitiesToAdd
e2a[#e2a + 1] = entity
end
return entity return entity
end end
tiny_addEntity = tiny.addEntity tiny_addEntity = tiny.addEntity
@@ -497,7 +485,7 @@ function tiny.add(world, ...)
end end
tiny_add = tiny.add tiny_add = tiny.add
--- Removes an Entity to the World. Returns the Entity. --- Removes an Entity from the World. Returns the Entity.
function tiny.removeEntity(world, entity) function tiny.removeEntity(world, entity)
local e2r = world.entitiesToRemove local e2r = world.entitiesToRemove
e2r[#e2r + 1] = entity e2r[#e2r + 1] = entity
@@ -529,7 +517,6 @@ function tiny.remove(world, ...)
end end
return ... return ...
end end
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)
@@ -543,7 +530,7 @@ function tiny_manageSystems(world)
world.systemsToAdd = {} world.systemsToAdd = {}
world.systemsToRemove = {} world.systemsToRemove = {}
local worldEntityList = world.entityList local worldEntityList = world.entities
local systems = world.systems local systems = world.systems
-- Remove Systems -- Remove Systems
@@ -623,58 +610,58 @@ end
-- Adds, removes, and changes Entities that have been marked. -- Adds, removes, and changes Entities that have been marked.
function tiny_manageEntities(world) function tiny_manageEntities(world)
local e2a = world.entitiesToAdd
local e2r = world.entitiesToRemove local e2r = world.entitiesToRemove
local e2c = world.entitiesToChange local e2c = world.entitiesToChange
-- Early exit -- Early exit
if #e2a == 0 and #e2r == 0 and #e2c == 0 then if #e2r == 0 and #e2c == 0 then
return return
end end
world.entitiesToChange = {} world.entitiesToChange = {}
world.entitiesToAdd = {}
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
-- Change Entities -- Change Entities
for i = 1, #e2c do for i = 1, #e2c do
local entity = e2c[i] local entity = e2c[i]
if entities[entity] then -- Add if needed
for j = 1, #systems do if not entities[entity] then
local system = systems[j] local index = #entities + 1
if not system.nocache then entities[entity] = index
local ses = system.entities entities[index] = entity
local seis = system.indices end
local index = seis[entity] for j = 1, #systems do
local filter = system.filter local system = systems[j]
if filter and filter(system, entity) then if not system.nocache then
if not index then local ses = system.entities
system.modified = true local seis = system.indices
index = #ses + 1 local index = seis[entity]
ses[index] = entity local filter = system.filter
seis[entity] = index if filter and filter(system, entity) then
local onAdd = system.onAdd if not index then
if onAdd then
onAdd(system, entity)
end
end
elseif index then
system.modified = true system.modified = true
local tmpEntity = ses[#ses] index = #ses + 1
ses[index] = tmpEntity ses[index] = entity
seis[tmpEntity] = index seis[entity] = index
seis[entity] = nil local onAdd = system.onAdd
ses[#ses] = nil if onAdd then
local onRemove = system.onRemove onAdd(system, entity)
if onRemove then
onRemove(system, entity)
end 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 end
@@ -688,12 +675,11 @@ function tiny_manageEntities(world)
local listIndex = entities[entity] local listIndex = entities[entity]
if listIndex then if listIndex then
-- Remove Entity from world state -- Remove Entity from world state
local lastEntity = entityList[#entityList] local lastEntity = entities[#entities]
entities[lastEntity] = listIndex entities[lastEntity] = listIndex
entities[entity] = nil entities[entity] = nil
entityList[listIndex] = lastEntity entities[listIndex] = lastEntity
entityList[#entityList] = nil entities[#entities] = nil
entityCount = entityCount - 1
-- Remove from cached systems -- Remove from cached systems
for j = 1, #systems do for j = 1, #systems do
local system = systems[j] local system = systems[j]
@@ -717,39 +703,6 @@ function tiny_manageEntities(world)
end end
end end
end end
-- Add Entities
for i = 1, #e2a do
local entity = e2a[i]
if not entities[entity] then
local listIndex = #entityList + 1
entities[entity] = listIndex
entityList[listIndex] = entity
entityCount = entityCount + 1
for j = 1, #systems do
local system = systems[j]
if not system.nocache then
local ses = system.entities
local seis = system.indices
local filter = system.filter
if filter and filter(system, entity) then
system.modified = true
local index = #ses + 1
ses[index] = entity
seis[entity] = index
local onAdd = system.onAdd
if onAdd then
onAdd(system, entity)
end
end
end
end
end
e2a[i] = nil
end
-- Update Entity count
world.entityCount = entityCount
end end
--- Manages Entities and Systems marked for deletion or addition. Call this --- Manages Entities and Systems marked for deletion or addition. Call this
@@ -759,7 +712,7 @@ function tiny.refresh(world)
tiny_manageSystems(world) tiny_manageSystems(world)
tiny_manageEntities(world) tiny_manageEntities(world)
local systems = world.systems local systems = world.systems
for i = 1, #systems do for i = #systems, 1, -1 do
local system = systems[i] local system = systems[i]
if system.active then if system.active then
local onModify = system.onModify local onModify = system.onModify
@@ -785,10 +738,17 @@ function tiny.update(world, dt, filter)
-- Iterate through Systems IN REVERSE ORDER -- Iterate through Systems IN REVERSE ORDER
for i = #systems, 1, -1 do for i = #systems, 1, -1 do
local system = systems[i] local system = systems[i]
local preWrap = system.preWrap if system.active then
if preWrap and system.active and -- Call the modify callback on Systems that have been modified.
((not filter) or filter(world, system)) then local onModify = system.onModify
preWrap(system, dt) if onModify and system.modified then
onModify(system, dt)
end
local preWrap = system.preWrap
if preWrap and
((not filter) or filter(world, system)) then
preWrap(system, dt)
end
end end
end end
@@ -797,12 +757,6 @@ function tiny.update(world, dt, filter)
local 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.
local onModify = system.onModify
if onModify and system.modified then
onModify(system, dt)
end
-- Update Systems that have an update method (most Systems) -- Update Systems that have an update method (most Systems)
local update = system.update local update = system.update
if update then if update then
@@ -811,9 +765,7 @@ function tiny.update(world, dt, filter)
local bufferedTime = (system.bufferedTime or 0) + dt local bufferedTime = (system.bufferedTime or 0) + dt
while bufferedTime >= interval do while bufferedTime >= interval do
bufferedTime = bufferedTime - interval bufferedTime = bufferedTime - interval
if update then update(system, interval)
update(system, interval)
end
end end
system.bufferedTime = bufferedTime system.bufferedTime = bufferedTime
else else
@@ -839,7 +791,7 @@ end
--- Removes all Entities from the World. --- Removes all Entities from the World.
function tiny.clearEntities(world) function tiny.clearEntities(world)
local el = world.entityList local el = world.entities
for i = 1, #el do for i = 1, #el do
tiny_removeEntity(world, el[i]) tiny_removeEntity(world, el[i])
end end
@@ -855,18 +807,12 @@ end
--- Gets number of Entities in the World. --- Gets number of Entities in the World.
function tiny.getEntityCount(world) function tiny.getEntityCount(world)
return world.entityCount return #world.entities
end end
--- Gets number of Systems in World. --- Gets number of Systems in World.
function tiny.getSystemCount(world) function tiny.getSystemCount(world)
return #(world.systems) return #world.systems
end
--- Gets the index of the System in the World.
-- A simpler alternative is `system.index`.
function tiny.getSystemIndex(world, system)
return system.index
end end
--- Sets the index of a System in the World, and returns the old index. Changes --- Sets the index of a System in the World, and returns the old index. Changes
@@ -905,10 +851,9 @@ worldMetaTable = {
clearSystems = tiny.clearSystems, clearSystems = tiny.clearSystems,
getEntityCount = tiny.getEntityCount, getEntityCount = tiny.getEntityCount,
getSystemCount = tiny.getSystemCount, getSystemCount = tiny.getSystemCount,
getSystemIndex = tiny.getSystemIndex,
setSystemIndex = tiny.setSystemIndex setSystemIndex = tiny.setSystemIndex
}, },
__tostring = function(self) __tostring = function()
return "<tiny-ecs_World>" return "<tiny-ecs_World>"
end end
} }