Concord/concord/assemblage.lua

--- Assemblage
-- An Assemblage is a function that 'makes' an entity something.
-- It does this by :give'ing or :ensure'ing Components, or by :assemble'ing the Entity.

local Assemblage = {}
Assemblage.__mt = {
   __index = Assemblage,
}

--- Creates a new Assemblage.
-- @param assemble Function that assembles an Entity
-- @return A new Assemblage
function Assemblage.new(assemble)
   local assemblage = setmetatable({
      __assemble = assemble,

      __name         = nil,
      __isAssemblage = true,
   }, Assemblage.__mt)

   return assemblage
end

--- Assembles an Entity.
-- @param e Entity to assemble
-- @param ... Varargs to pass to the assemble function
-- @ return self
function Assemblage:assemble(e, ...)
   self.__assemble(e, ...)

   return self
end

--- Returns true if the Assemblage has a name.
-- @return True if the Assemblage has a name, false otherwise
function Assemblage:hasName()
   return self.__name and true or false
end

--- Returns the name of the Assemblage.
-- @return Name of the Assemblage
function Assemblage:getName()
   return self.__name
end

return setmetatable(Assemblage, {
   __call = function(_, ...)
      return Assemblage.new(...)
   end,
})