mirror of
https://github.com/Keyslam-Group/Concord.git
synced 2025-09-02 12:24:11 -04:00
67d67aad5f
* Added a "nothing docstring" at the top of each file we want to generate docs for. We have to do this or ldoc just straight up refuses to generate docs otherwise. * Fixed up a few incorrect docstrings * config.ld is the config file for ldoc These still need some work: a bunch of functions are still undocumented and also: type.lua & run.lua are completely undocumented.
104 lines
2.5 KiB
Lua
104 lines
2.5 KiB
Lua
--- Entity
|
|
|
|
local PATH = (...):gsub('%.[^%.]+$', '')
|
|
|
|
local Type = require(PATH..".type")
|
|
local List = require(PATH..".list")
|
|
|
|
local Entity = {}
|
|
Entity.__index = Entity
|
|
|
|
--- Creates and initializes a new Entity.
|
|
-- @return A new Entity
|
|
function Entity.new()
|
|
local e = setmetatable({
|
|
components = {},
|
|
removed = {},
|
|
instances = List(),
|
|
|
|
__isEntity = true,
|
|
}, Entity)
|
|
|
|
return e
|
|
end
|
|
|
|
--- Gives an Entity a component with values.
|
|
-- @param component The Component to add
|
|
-- @param ... The values passed to the Component
|
|
-- @return self
|
|
function Entity:give(component, ...)
|
|
if not Type.isComponent(component) then
|
|
error("bad argument #1 to 'Entity:give' (Component expected, got "..type(component)..")", 2)
|
|
end
|
|
|
|
local comp = component:__initialize(...)
|
|
self.components[component] = comp
|
|
self[component] = comp
|
|
|
|
return self
|
|
end
|
|
|
|
--- Removes a component from an Entity.
|
|
-- @param component The Component to remove
|
|
-- @return self
|
|
function Entity:remove(component)
|
|
if not Type.isComponent(component) then
|
|
error("bad argument #1 to 'Entity:remove' (Component expected, got "..type(component)..")")
|
|
end
|
|
|
|
self.removed[component] = true
|
|
|
|
return self
|
|
end
|
|
|
|
--- Checks the Entity against the pools again.
|
|
-- @return self
|
|
function Entity:apply()
|
|
for i = 1, self.instances.size do
|
|
self.instances:get(i):checkEntity(self)
|
|
end
|
|
|
|
for component, _ in pairs(self.removed) do
|
|
self.components[component] = nil
|
|
self[component] = nil
|
|
self.removed[component] = nil
|
|
end
|
|
|
|
return self
|
|
end
|
|
|
|
--- Destroys the Entity.
|
|
-- @return self
|
|
function Entity:destroy()
|
|
for i = 1, self.instances.size do
|
|
self.instances:get(i):removeEntity(self)
|
|
end
|
|
|
|
return self
|
|
end
|
|
|
|
--- Gets a Component from the Entity.
|
|
-- @param component The Component to get
|
|
-- @return The Bag from the Component
|
|
function Entity:get(component)
|
|
if not Type.isComponent(component) then
|
|
error("bad argument #1 to 'Entity:get' (Component expected, got "..type(component)..")")
|
|
end
|
|
|
|
return self.components[component]
|
|
end
|
|
|
|
--- Returns true if the Entity has the Component.
|
|
-- @param component The Component to check against
|
|
-- @return True if the entity has the Bag. False otherwise
|
|
function Entity:has(component)
|
|
if not Type.isComponent(component) then
|
|
error("bad argument #1 to 'Entity:has' (Component expected, got "..type(component)..")")
|
|
end
|
|
|
|
return self.components[component] ~= nil
|
|
end
|
|
|
|
return setmetatable(Entity, {
|
|
__call = function(_, ...) return Entity.new(...) end,
|
|
})
|