Files
simple-makes-complex/mods/SYSTEM/Mod/init.lua

80 lines
1.9 KiB
Lua

---Luanti mod
---@class Mod
Mod = {}
---@class Mod.Info
---@field name string
---@field shortName string
---@field path string
---@field require fun(fileName:string):table
---@field load fun(class:table, fileName:string)
---Returns the mod name without prefixes
---@param name string
---@return string
local function getShortModName(name)
local shortName = string.gsub(name, '%w*__', '')
return shortName
end
---Return table with mod name, path and require function.
---@param modname? string Specify a name of mod to get its info
---@return Mod.Info
function Mod.getInfo(modname)
local name = modname or core.get_current_modname()
local shortName = getShortModName(name)
local path = core.get_modpath(name)
assert(path ~= nil, ('A mod `%s` does not exist.'):format(name))
local require = Require:getModRequire(name, path)
local load = Require:getModLoad(name, path)
local info = {
name = name,
shortName = shortName,
path = path,
require = require,
load = load
}
return info
end
--[[
function Mod:new()
---@type Mod
local instance = setmetatable(Mod.getInfo(), { __index = self })
return instance
end
---Get an instance of a public class provided by a mod
---@param ... any?
---@return table
function Mod:getModClassInstance(...)
local classInstance = self.Class:new(...)
return classInstance
end
---Inherits a child class from a parent class
---@param ParentClass table
---@param ChildClass table?
---@return table
function Mod:getClassExtended(ParentClass, ChildClass)
local childClass = setmetatable(ChildClass or {}, { __index = ParentClass })
return childClass
end
---Inherits a child class from a parent public class provided by the mod.
---@param ChildClass table?
---@return table
function Mod:getModClassExtended(ChildClass)
local childClass = Mod:getClassExtended(self.Class, ChildClass or {})
return childClass
end --]]
return Mod