sage
/
tiny-ecs-love-template
Template
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Move tiny-tools into tiny.lua directly. 

Less implicit global var work.
The global is still there, but it's explicitly captured in world.lua, removing any weird require-ordering rules.
This commit is contained in:
Sage Vaillancourt 2025-03-19 15:27:53 -04:00
parent 59e7095470
commit aca14fbfb0
14 changed files with 107 additions and 99 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

48
lib/tiny.lua
View File

@ -905,6 +905,53 @@ function tiny.setSystemIndex(world, system, index)
return oldIndex
end
---@author Sage Vaillancourt
---
--- A convenience function for quickly building a well-typed system matching the given shape.
--- Typing does not work when a literal tiny filter is passed as the `shape`, but this function can still be convenient.
---@generic T
---@param name string The `.name` of the system. Shouldn't be used for identifying it in code, but can be helpful when debugging.
---@param shape T | fun()
---@param process fun(entity: T, dt: number, system: System) | nil
---@param compare nil | fun(system: System, entityA: T, entityB: T): boolean If provided, will instead initialize a sortedProcessingSystem.
---@return System | { entities: T[] }
function tiny.filteredSystem(world, name, shape, process, compare)
assert(type(name) == "string")
assert(process == nil or type(process) == "function")
local system = compare and tiny.sortedProcessingSystem() or tiny.processingSystem()
system.compare = compare
system.name = name
if type(shape) == "table" then
local keys = {}
for key, value in pairs(shape) do
local isTable = type(value) == "table"
local isMaybe = isTable and value.maybe ~= nil
if not isMaybe then
-- ^ Don't require any Maybe types
keys[#keys + 1] = key
end
end
system.filter = tiny.requireAll(unpack(keys))
elseif type(shape) == "function" then
system.filter = shape
else
error("Unknown type for `shape` argument: " .. type(shape))
end
if not process then
return world:addSystem(system)
end
function system:process(e, dt)
process(e, dt, self)
end
return world:addSystem(system)
end
-- Construct world metatable.
worldMetaTable = {
__index = {
@ -921,6 +968,7 @@ worldMetaTable = {
getEntityCount = tiny.getEntityCount,
getSystemCount = tiny.getSystemCount,
setSystemIndex = tiny.setSystemIndex,
filteredSystem = tiny.filteredSystem,
},
__tostring = function()
return "<tiny-ecs_World>"

17
main.lua
View File

@ -1,20 +1,17 @@
require("tiny-debug")
require("utils")
require("tiny-tools")
local tiny = require("lib/tiny")
World = tiny.world()
require("generated/filter-types")
require("generated/assets")
require("generated/all-systems")
local world = require("world")
local scenarios = {
default = function()
-- TODO: Add default entities
end,
textTestScenario = function()
World:addEntity({
world:addEntity({
position = { x = 0, y = 600 },
drawAsText = {
text = "Hello, world!",
@ -41,7 +38,7 @@ function love.update(dt)
delta = dt
if love.keyboard.isDown("r") then
World:clearEntities()
world:clearEntities()
currentScenario()
freeze = false
end
@ -54,7 +51,7 @@ function love.update(dt)
return
end
World:update(delta, function(_, system)
world:update(delta, function(_, system)
if system.deferToEnd then
return false
end
@ -63,14 +60,14 @@ function love.update(dt)
end
function love.draw()
World:update(delta, function(_, system)
world:update(delta, function(_, system)
if system.deferToEnd then
return false
end
return system.isDrawSystem
end)
World:update(delta, function(_, system)
world:update(delta, function(_, system)
return system.deferToEnd
end)
end

41
systems/camera-pan.lua
View File

@ -1,15 +1,18 @@
Camera = {
local world = require("world")
local camera = {
pan = {
x = 0,
y = 0,
},
}
expireBelowScreenSystem = filteredSystem("expireBelowScreen", { position = T.XyPair, expireBelowScreenBy = T.number })
local expireBelowScreen =
world:filteredSystem("expireBelowScreen", { position = T.XyPair, expireBelowScreenBy = T.number })
local focusPriority = {}
cameraPanSystem = filteredSystem("cameraPan", { focusPriority = T.number, position = T.XyPair }, function(e, _)
cameraPanSystem = world:filteredSystem("cameraPan", { focusPriority = T.number, position = T.XyPair }, function(e, _)
if e.focusPriority >= focusPriority.priority then
focusPriority.position = e.position
end
@ -21,35 +24,13 @@ function cameraPanSystem.preProcess()
end
function cameraPanSystem:postProcess()
Camera.pan.x = math.max(0, focusPriority.position.x - 200)
Camera.pan.y = math.min(0, focusPriority.position.y - 120)
-- TODO: set draw offset
camera.pan.x = math.max(0, focusPriority.position.x - 200)
camera.pan.y = math.min(0, focusPriority.position.y - 120)
love.graphics.translate(0, -camera.pan.y)
for _, entity in pairs(expireBelowScreenSystem.entities) do
if entity.position.y - (Camera.pan.y + 240) > entity.expireBelowScreenBy then
for _, entity in pairs(expireBelowScreen.entities) do
if entity.position.y - (camera.pan.y + 240) > entity.expireBelowScreenBy then
self.world:removeEntity(entity)
end
end
end
local cameraTopIsh, cameraBottomIsh
local enableNearCameraY = filteredSystem(
"enableNearCameraY",
{ enableNearCameraY = Arr(T.Entity) },
function(e, _, system)
if e.position.y > cameraTopIsh and e.position.y < cameraBottomIsh then
for _, enable in ipairs(e.enableNearCameraY) do
enable.velocity = e.velocity
system.world:addEntity(enable)
end
system.world:removeEntity(e)
end
end
)
local within = 1000
function enableNearCameraY:preProcess()
cameraTopIsh = Camera.pan.y - within
cameraBottomIsh = Camera.pan.y + 240 + within
end

10
systems/collision-detection.lua
View File

@ -1,4 +1,6 @@
collidingEntities = filteredSystem("collidingEntitites", {
local world = require("world")
local collidingEntities = world:filteredSystem("collidingEntitites", {
position = T.XyPair,
size = T.XyPair,
canCollideWith = T.BitMask,
@ -19,14 +21,14 @@ local function intersects(rect, rectOther)
return leftOther < right and left < rightOther and topOther < bottom and top < bottomOther
end
filteredSystem(
world:filteredSystem(
"collisionDetection",
{ position = T.XyPair, size = T.XyPair, canBeCollidedBy = T.BitMask, isSolid = Maybe(T.bool) },
-- Here, the entity, e, refers to some entity that a moving object may be colliding *into*
-- Here, the entity, e, refers to some entity that a moving object may be colliding *into*
function(e, _, system)
for _, collider in pairs(collidingEntities.entities) do
if
(e ~= collider)
(e ~= collider)
and collider.canCollideWith
and e.canBeCollidedBy
and bit.band(collider.canCollideWith, e.canBeCollidedBy) ~= 0

4
systems/collision-resolution.lua
View File

@ -1,4 +1,6 @@
filteredSystem("collisionResolution", { collisionBetween = T.Collision }, function(e, _, system)
local world = require("world")
world:filteredSystem("collisionResolution", { collisionBetween = T.Collision }, function(e, _, system)
local collidedInto, collider = e.collisionBetween[1], e.collisionBetween[2]
system.world:removeEntity(e)
end)

8
systems/decay.lua
View File

@ -1,15 +1,17 @@
filteredSystem("decay", { decayAfterSeconds = T.number }, function(e, dt, system)
local world = require("world")
world:filteredSystem("decay", { decayAfterSeconds = T.number }, function(e, dt, system)
e.decayAfterSeconds = e.decayAfterSeconds - dt
if e.decayAfterSeconds <= 0 then
system.world:removeEntity(e)
end
end)
LiveForNFrames = filteredSystem("liveForNFrames", { liveForNFrames = T.number }, function(e, _, system)
LiveForNFrames = world:filteredSystem("liveForNFrames", { liveForNFrames = T.number }, function(e, _, system)
e.liveForNFrames = e.liveForNFrames - 1
if e.liveForNFrames <= 0 then
system.world:removeEntity(e)
end
end)
LiveForNFrames.deferToEnd = true
LiveForNFrames.deferToEnd = true

3
systems/draw.lua
View File

@ -1,3 +1,4 @@
local world = require("world")
local gfx = love.graphics
---@generic T
@ -5,7 +6,7 @@ local gfx = love.graphics
---@param process fun(entity: T, dt: number, system: System) | nil
---@return System | { entities: T[] }
local function drawSystem(name, shape, process)
local system = filteredSystem(name, shape, process, function(_, a, b)
local system = world:filteredSystem(name, shape, process, function(_, a, b)
if a.z ~= nil and b.z ~= nil then
return a.z < b.z
end

9
systems/gravity.lua
View File

@ -1,16 +1,17 @@
local world = require("world")
local min = math.min
World:addEntity({ gravity = -300 })
world:addEntity({ gravity = -300 })
local gravities = filteredSystem("gravities", { gravity = T.number })
local gravities = world:filteredSystem("gravities", { gravity = T.number })
filteredSystem("changeGravity", { changeGravityTo = T.number }, function(e, _, _)
world:filteredSystem("changeGravity", { changeGravityTo = T.number }, function(e, _, _)
for _, ge in pairs(gravities.entities) do
ge.gravity = e.changeGravityTo
end
end)
filteredSystem("fall", { velocity = T.XyPair, mass = T.number }, function(e, dt)
world:filteredSystem("fall", { velocity = T.XyPair, mass = T.number }, function(e, dt)
for _, ge in pairs(gravities.entities) do
e.velocity.y = min(400, e.velocity.y - (ge.gravity * dt * e.mass) - (0.5 * dt * dt))
end

10
systems/input.lua
View File

@ -1,7 +1,9 @@
local world = require("world")
---@type KeyState
local keyState = {}
local keyInputSystem = filteredSystem("keyInput", { canReceiveKeys = T.marker }, function(e, _, system)
local keyInputSystem = world:filteredSystem("keyInput", { canReceiveKeys = T.marker }, function(e, _, system)
e.keyState = keyState
system.world:addEntity(e)
end)
@ -22,7 +24,7 @@ function ClearKeyState()
end
end
local mouse = filteredSystem("mouse", { mouseKeyPress = { position = T.XyPair, key = T.number } })
local mouse = world:filteredSystem("mouse", { mouseKeyPress = { position = T.XyPair, key = T.number } })
function MouseJustPressed(key, clear)
clear = clear ~= nil and clear or true
@ -30,7 +32,7 @@ function MouseJustPressed(key, clear)
if event.mouseKeyPress and event.mouseKeyPress.key == key then
if clear then
event.mouseKeyPress = nil
World:removeEntity(event)
world:removeEntity(event)
end
return true
end
@ -45,7 +47,7 @@ function love.mousemoved(x, y)
end
function love.mousepressed(x, y, key)
World:addEntity({
world:addEntity({
mouseKeyPress = {
position = {
x = x,

7
systems/velocity.lua
View File

@ -1,6 +1,7 @@
local world = require("world")
local sqrt = math.sqrt
filteredSystem("velocity", { position = T.XyPair, velocity = T.XyPair }, function(e, dt, system)
world:filteredSystem("velocity", { position = T.XyPair, velocity = T.XyPair }, function(e, dt, system)
if sqrt((e.velocity.x * e.velocity.x) + (e.velocity.y * e.velocity.y)) < 2 then
-- velocity = nil
else
@ -9,8 +10,8 @@ filteredSystem("velocity", { position = T.XyPair, velocity = T.XyPair }, functio
end
end)
filteredSystem("drag", { velocity = T.XyPair, drag = T.number }, function(e, dt, system)
world:filteredSystem("drag", { velocity = T.XyPair, drag = T.number }, function(e, dt, system)
local currentDrag = e.drag * dt
e.velocity.x = e.velocity.x - (e.velocity.x * currentDrag * dt)
e.velocity.y = e.velocity.y - (e.velocity.y * currentDrag * dt)
end)
end)

2
tiny-debug.lua
View File

@ -39,4 +39,4 @@ if tinyWarnWhenNonDataOnEntities then
return valType
end
end
end
end

38
tiny-tools.lua
View File

@ -1,38 +0,0 @@
local tiny = require("lib/tiny")
---@generic T
---@param shape T | fun()
---@param process fun(entity: T, dt: number, system: System) | nil
---@param compare nil | fun(system: System, entityA: T, entityB: T): boolean
---@return System | { entities: T[] }
function filteredSystem(name, shape, process, compare)
assert(type(name) == "string")
assert(type(shape) == "table" or type(shape) == "function")
assert(process == nil or type(process) == "function")
local system = compare and tiny.sortedProcessingSystem() or tiny.processingSystem()
system.compare = compare
system.name = name
if type(shape) == "table" then
local keys = {}
for key, value in pairs(shape) do
local isTable = type(value) == "table"
local isMaybe = isTable and value.maybe ~= nil
if not isMaybe then
-- ^ Don't require any Maybe types
keys[#keys + 1] = key
end
end
system.filter = tiny.requireAll(unpack(keys))
elseif type(shape) == "function" then
system.filter = shape
end
if not process then
return World:addSystem(system)
end
function system:process(e, dt)
process(e, dt, self)
end
return World:addSystem(system)
end

7
tiny-types.lua
View File

@ -46,3 +46,10 @@ function World:getSystemCount() end
--- the order in which they Systems processed, because lower indexed Systems are
--- processed first. Returns the old system.index.
function World:setSystemIndex(world, system, index) end
---@generic T
---@param shape T | fun()
---@param process fun(entity: T, dt: number, system: System) | nil
---@param compare nil | fun(system: System, entityA: T, entityB: T): boolean
---@return System | { entities: T[] }
function World:filteredSystem(name, shape, process, compare) end

2
world.lua Normal file
View File

@ -0,0 +1,2 @@
local tiny = require("lib/tiny")
return tiny.world()