diff --git a/mods/CORE/ProgressionSystem/init.lua b/mods/CORE/ProgressionSystem/init.lua new file mode 100644 index 0000000..271fe85 --- /dev/null +++ b/mods/CORE/ProgressionSystem/init.lua @@ -0,0 +1,4 @@ +local modInfo = Mod.getInfo('smc__core__progression_system') +local require = modInfo.require + +return require('ProgressionSystem') diff --git a/mods/CORE/ProgressionSystem/mod.conf b/mods/CORE/ProgressionSystem/mod.conf new file mode 100644 index 0000000..9253ab4 --- /dev/null +++ b/mods/CORE/ProgressionSystem/mod.conf @@ -0,0 +1,2 @@ +name = smc__core__progression_system +depends = smc__system__system_loader diff --git a/mods/CORE/ProgressionSystem/src/ProgressionSystem.lua b/mods/CORE/ProgressionSystem/src/ProgressionSystem.lua new file mode 100644 index 0000000..db4da88 --- /dev/null +++ b/mods/CORE/ProgressionSystem/src/ProgressionSystem.lua @@ -0,0 +1,89 @@ +local assert = assert + +local require = Mod.getInfo('smc__core__progression_system').require + +---@type ProgressionSystem.Age +local Age = require('ProgressionSystem.Age') +---@type ProgressionSystem.Milestone +local Milestone = require('ProgressionSystem.Milestone') + +---The zeroth century, from which progression begins. +--- +---It is not registered through the usual mechanism, +---but is integrated directly into the progression system. +local zeroAge = Age:new('zero', {}) +zeroAge.id = 0 + +---@class ProgressionSystem +---@field agesByName table +---@field agesByID table +--- +---The age ID currently reached by players in global progression. +---@field serverAge integer +local ProgressionSystem = { + agesByName = { ['zero'] = zeroAge, }, + agesByID = { [0] = zeroAge }, + serverAge = 0, +} + +---@param ageName ProgressionSystem.Age.Name +---@param def ProgressionSystem.AgeDef +function ProgressionSystem:registerAge(ageName, def) + assert(self.agesByName[ageName] == nil) + + local age = Age:new(ageName, def) + self.agesByName[ageName] = age + + age.id = #self.agesByID + 1 + self.agesByID[age.id] = age +end + +---@param ageName ProgressionSystem.Age.Name +---@return ProgressionSystem.Age +function ProgressionSystem:getAgeByName(ageName) + assert(self.agesByName[ageName] ~= nil) + + return self.agesByName[ageName] +end + +---@param id integer +---@return ProgressionSystem.Age +function ProgressionSystem:getAgeByID(id) + assert(self.agesByName[id] ~= nil) + + return self.agesByName[id] +end + +---@param ageName ProgressionSystem.Age.Name +---@param milestoneName string +---@param def ProgressionSystem.MilestoneDef +function ProgressionSystem:registerMilestone(ageName, milestoneName, def) + local age = self:getAgeByName(ageName) + + local milestone = Milestone:new(milestoneName, def) + + age:addMilestone(milestoneName, milestone) +end + +---@param ageName ProgressionSystem.Age.Name +---@param milestoneName string +---@return ProgressionSystem.Milestone +function ProgressionSystem:getMilestoneByName(ageName, milestoneName) + local age = self:getAgeByName(ageName) + + return age:getMilestoneByName(milestoneName) +end + +---@param ageID integer +function ProgressionSystem:setServerAge(ageID) + assert(ageID <= #self.agesByID) + + self.serverAge = ageID +end + +---@return integer +function ProgressionSystem:getServerAge() + return self.serverAge +end + +return ProgressionSystem diff --git a/mods/CORE/ProgressionSystem/src/ProgressionSystem/Age.lua b/mods/CORE/ProgressionSystem/src/ProgressionSystem/Age.lua new file mode 100644 index 0000000..327e40f --- /dev/null +++ b/mods/CORE/ProgressionSystem/src/ProgressionSystem/Age.lua @@ -0,0 +1,48 @@ +local assert = assert + +local tableInsert = table.insert + +---@alias ProgressionSystem.Age.Name +---| 'zero' +---| '' + +---@class ProgressionSystem.Age : Class +---@field name ProgressionSystem.Age.Name +---@field id integer +--- +---@field milestonesByName ProgressionSystem.Milestone[] +---@field milestonesList ProgressionSystem.Milestone[] +local Age = Class:extend({ + milestonesByName = {}, + milestonesList = {}, +}) + +---@class ProgressionSystem.AgeDef + +---@param name ProgressionSystem.Age.Name +---@param def ProgressionSystem.AgeDef +function Age:new(name, def) + local instance = self:getInstance({}) + instance.name = name + + return instance +end + +---@param milestoneName string +---@param milestone ProgressionSystem.Milestone +function Age:addMilestone(milestoneName, milestone) + assert(self.milestonesByName[milestoneName] == nil) + + self.milestonesByName[milestoneName] = milestone + tableInsert(self.milestonesList, milestone) +end + +---@param milestoneName string +---@return ProgressionSystem.Milestone +function Age:getMilestoneByName(milestoneName) + assert(self.milestonesByName[milestoneName] ~= nil) + + return self.milestonesByName[milestoneName] +end + +return Age diff --git a/mods/CORE/ProgressionSystem/src/ProgressionSystem/Milestone.lua b/mods/CORE/ProgressionSystem/src/ProgressionSystem/Milestone.lua new file mode 100644 index 0000000..67bf831 --- /dev/null +++ b/mods/CORE/ProgressionSystem/src/ProgressionSystem/Milestone.lua @@ -0,0 +1,16 @@ +---@class ProgressionSystem.Milestone : Class +---@field name string +local Milestone = Class:extend() + +---@class ProgressionSystem.MilestoneDef + +---@param name string +---@param def ProgressionSystem.MilestoneDef +function Milestone:new(name, def) + local instance = self:getInstance({}) + instance.name = name + + return instance +end + +return Milestone