mirror of
https://github.com/Keyslam-Group/Concord.git
synced 2025-08-20 21:38:29 -04:00
a65f88dd5e
main changes: - add parameter and return types where applicable - use @module and @classmod tags at the top of files - remove some redundant descriptions of return values, especially for functions that return a boolean recommended next steps: - more consistent grammar - add links to classes and functions in descriptions where appropriate - be consistent about naming Systems vs. SystemClasses and Components vs. ComponentClasses
48 lines
1.3 KiB
Lua
48 lines
1.3 KiB
Lua
--- Worlds
|
|
-- Container for registered Worlds
|
|
|
|
local PATH = (...):gsub('%.[^%.]+$', '')
|
|
|
|
local Type = require(PATH..".type")
|
|
|
|
local Worlds = {}
|
|
|
|
--- Registers a World.
|
|
-- @tparam string name Name to register under
|
|
-- @param world World to register
|
|
function Worlds.register(name, world)
|
|
if (type(name) ~= "string") then
|
|
error("bad argument #1 to 'Worlds.register' (string expected, got "..type(name)..")", 3)
|
|
end
|
|
|
|
if (not Type.isWorld(world)) then
|
|
error("bad argument #2 to 'Worlds.register' (world expected, got "..type(world)..")", 3)
|
|
end
|
|
|
|
if (rawget(Worlds, name)) then
|
|
error("bad argument #2 to 'Worlds.register' (World with name '"..name.."' is already registerd)", 3)
|
|
end
|
|
|
|
Worlds[name] = world
|
|
world.__name = name
|
|
end
|
|
|
|
--- Returns true if the containter has the World with the name
|
|
-- @tparam string name Name of the World to check
|
|
-- @treturn boolean
|
|
function Worlds.has(name)
|
|
return Worlds[name] and true or false
|
|
end
|
|
|
|
--- Returns the World with the name
|
|
-- @tparam string name Name of the World to get
|
|
-- @return World with the name
|
|
function Worlds.get(name)
|
|
return Worlds[name]
|
|
end
|
|
|
|
return setmetatable(Worlds, {
|
|
__index = function(_, name)
|
|
error("Attempt to index world '"..tostring(name).."' that does not exist / was not registered", 2)
|
|
end
|
|
})
|