Rethinking structure a bit

media/lua/client/TOC/Controllers/DataController.lua

@@ -0,0 +1,390 @@
+local CommandsData = require("TOC/CommandsData")
+local StaticData = require("TOC/StaticData")
+----------------
+
+--- An instance will be abbreviated with dcInst
+
+
+--- Handle all TOC mod data related stuff
+---@class DataController
+---@field username string
+---@field tocData tocModDataType
+---@field isDataReady boolean
+---@field isResetForced boolean
+local DataController = {}
+DataController.instances = {}
+
+---Setup a new Mod Data Handler
+---@param username string
+---@param isResetForced boolean?
+---@return DataController
+function DataController:new(username, isResetForced)
+    TOC_DEBUG.print("[DataController] NEW for " .. username)
+    --error("TEST TRIGGER")
+    local o = {}
+    setmetatable(o, self)
+    self.__index = self
+
+    o.username = username
+    local key = CommandsData.GetKey(username)
+
+    -- We don't want to request ModData if we're in SP, or if we're forcing a reset
+    if isClient() and not isResetForced then
+        ModData.request(key)
+        o.isResetForced = isResetForced
+        o.isDataReady = false
+    elseif isResetForced then
+        self:setup(key)
+        o.isResetForced = false
+        o.isDataReady = true
+    end
+
+    DataController.instances[username] = o
+
+    return o
+end
+
+---Setup a new toc mod data data class
+---@param key string
+function DataController:setup(key)
+    TOC_DEBUG.print("[DataController] Running setup")
+
+    ---@type tocModDataType
+    self.tocData = {
+        -- Generic stuff that does not belong anywhere else
+        isIgnoredPartInfected = false,
+        isAnyLimbCut = false,
+        limbs = {},
+        prostheses = {}
+    }
+
+    ---@type partData
+    local defaultParams = {
+        isCut = false, isInfected = false, isOperated = false, isCicatrized = false, isCauterized = false,
+        woundDirtyness = -1, cicatrizationTime = -1,
+        isVisible = false
+    }
+
+    -- Initialize limbs
+    for i=1, #StaticData.LIMBS_STR do
+        local limbName = StaticData.LIMBS_STR[i]
+        self.tocData.limbs[limbName] = {}
+        self:setLimbParams(StaticData.LIMBS_STR[i], defaultParams, 0)
+    end
+
+    -- Initialize prostheses stuff
+    for i=1, #StaticData.PROSTHESES_GROUPS_STR do
+        local group = StaticData.PROSTHESES_GROUPS_STR[i]
+        self.tocData.prostheses[group] = {
+            isProstEquipped = false,
+            prostFactor = 0,
+        }
+    end
+
+    -- Add it to global mod data
+    ModData.add(key, self.tocData)
+
+end
+
+---In case of desync between the table on ModData and the table here
+---@param tocData tocModDataType
+function DataController:reapplyTocData(tocData)
+    local key = CommandsData.GetKey(self.username)
+    ModData.add(key, tocData)
+    self.tocData = ModData.get(key)
+end
+
+-----------------
+--* Setters *--
+
+function DataController:setIsDataReady(isDataReady)
+    self.isDataReady = isDataReady
+end
+
+---Set a generic boolean that toggles varies function of the mod
+---@param isAnyLimbCut boolean
+function DataController:setIsAnyLimbCut(isAnyLimbCut)
+    self.tocData.isAnyLimbCut = isAnyLimbCut
+end
+
+---Set isIgnoredPartInfected
+---@param isIgnoredPartInfected boolean
+function DataController:setIsIgnoredPartInfected(isIgnoredPartInfected)
+    self.tocData.isIgnoredPartInfected = isIgnoredPartInfected
+end
+
+---Set isCut 
+---@param limbName string
+---@param isCut boolean
+function DataController:setIsCut(limbName, isCut)
+    self.tocData.limbs[limbName].isCut = isCut
+end
+
+---Set isInfected
+---@param limbName string
+---@param isInfected boolean
+function DataController:setIsInfected(limbName, isInfected)
+    self.tocData.limbs[limbName].isInfected = isInfected
+end
+
+---Set isCicatrized
+---@param limbName string
+---@param isCicatrized boolean
+function DataController:setIsCicatrized(limbName, isCicatrized)
+    self.tocData.limbs[limbName].isCicatrized = isCicatrized
+end
+
+---Set isCauterized
+---@param limbName string
+---@param isCauterized boolean
+function DataController:setIsCauterized(limbName, isCauterized)
+    self.tocData.limbs[limbName].isCauterized = isCauterized
+end
+
+---Set woundDirtyness
+---@param limbName string
+---@param woundDirtyness number
+function DataController:setWoundDirtyness(limbName, woundDirtyness)
+    self.tocData.limbs[limbName].woundDirtyness = woundDirtyness
+end
+
+
+---Set cicatrizationTime
+---@param limbName string
+---@param cicatrizationTime number
+function DataController:setCicatrizationTime(limbName, cicatrizationTime)
+    self.tocData.limbs[limbName].cicatrizationTime = cicatrizationTime
+end
+
+---Set isProstEquipped
+---@param group string
+---@param isProstEquipped boolean
+function DataController:setIsProstEquipped(group, isProstEquipped)
+    self.tocData.prostheses[group].isProstEquipped = isProstEquipped
+end
+
+---Set prostFactor
+---@param group string
+---@param prostFactor number
+function DataController:setProstFactor(group, prostFactor)
+    self.tocData.prostheses[group].prostFactor = prostFactor
+end
+
+-----------------
+--* Getters *--
+
+---comment
+---@return boolean
+function DataController:getIsDataReady()
+    return self.isDataReady
+end
+---Set a generic boolean that toggles varies function of the mod
+---@return boolean
+function DataController:getIsAnyLimbCut()
+    --if self.isDataReady == false then return false end
+    return self.tocData.isAnyLimbCut
+end
+
+---Get isIgnoredPartInfected
+---@return boolean
+function DataController:getIsIgnoredPartInfected()
+    return self.tocData.isIgnoredPartInfected
+end
+
+---Get isCut
+---@param limbName string
+---@return boolean
+function DataController:getIsCut(limbName)
+    if not self.isDataReady then return false end
+
+    if self.tocData.limbs[limbName] then
+        return self.tocData.limbs[limbName].isCut
+    else
+        return false
+    end
+end
+
+---Get isVisible
+---@param limbName string
+---@return boolean
+function DataController:getIsVisible(limbName)
+    if not self.isDataReady then return false end
+
+    return self.tocData.limbs[limbName].isVisible
+end
+
+---Get isCicatrized
+---@param limbName string
+---@return boolean
+function DataController:getIsCicatrized(limbName)
+    return self.tocData.limbs[limbName].isCicatrized
+end
+
+---Get isCauterized
+---@param limbName string
+---@return boolean
+function DataController:getIsCauterized(limbName)
+    return self.tocData.limbs[limbName].isCauterized
+end
+
+---Get woundDirtyness
+---@param limbName string
+---@return number
+function DataController:getWoundDirtyness(limbName)
+    return self.tocData.limbs[limbName].woundDirtyness
+end
+
+
+---Get cicatrizationTime
+---@param limbName string
+---@return number
+function DataController:getCicatrizationTime(limbName)
+    return self.tocData.limbs[limbName].cicatrizationTime
+end
+
+---Get isProstEquipped
+---@param group string
+---@return boolean
+function DataController:getIsProstEquipped(group)
+    return self.tocData.prostheses[group].isProstEquipped
+end
+
+---Get prostFactor
+---@param group string
+---@return number
+function DataController:getProstFactor(group)
+    return self.tocData.prostheses[group].prostFactor
+end
+
+--* Limbs data handling *--
+
+---Set a limb and its dependend limbs as cut
+---@param limbName string
+---@param isOperated boolean
+---@param isCicatrized boolean
+---@param isCauterized boolean
+---@param surgeonFactor number?
+function DataController:setCutLimb(limbName, isOperated, isCicatrized, isCauterized, surgeonFactor)
+    local cicatrizationTime = 0
+    if isCicatrized == false or isCauterized == false then
+        cicatrizationTime = StaticData.LIMBS_CICATRIZATION_TIME_IND_NUM[limbName] - surgeonFactor
+    end
+
+    -- TODO Set WoundDirtyness here! For now it's just 0 
+
+    ---@type partData
+    local params = {isCut = true, isInfected = false, isOperated = isOperated, isCicatrized = isCicatrized, isCauterized = isCauterized, woundDirtyness = 0, isVisible = true}
+    self:setLimbParams(limbName, params, cicatrizationTime)
+
+    for i=1, #StaticData.LIMBS_DEPENDENCIES_IND_STR[limbName] do
+        local dependedLimbName = StaticData.LIMBS_DEPENDENCIES_IND_STR[limbName][i]
+
+        -- We don't care about isOperated, isCicatrized, isCauterized since this is depending on another limb
+        -- Same story for cicatrizationTime, which will be 0
+        -- isCicatrized is to true to prevent it from doing the cicatrization process
+        self:setLimbParams(dependedLimbName, {isCut = true, isInfected = false, isVisible = false, isCicatrized = true}, 0)
+    end
+
+    -- Set that a limb has been cut, to activate some functions without having to loop through the parts
+    self:setIsAnyLimbCut(true)
+
+    -- TODO In theory we should cache data from here, not AmputationHandler
+end
+
+---Set a limb data
+---@param limbName string
+---@param ampStatus partData {isCut, isInfected, isOperated, isCicatrized, isCauterized, isVisible}
+---@param cicatrizationTime integer?
+function DataController:setLimbParams(limbName, ampStatus, cicatrizationTime)
+    local limbData = self.tocData.limbs[limbName]
+    if ampStatus.isCut ~= nil then limbData.isCut = ampStatus.isCut end
+    if ampStatus.isInfected ~= nil then limbData.isInfected = ampStatus.isInfected end
+    if ampStatus.isOperated ~= nil then limbData.isOperated = ampStatus.isOperated end
+    if ampStatus.isCicatrized ~= nil then limbData.isCicatrized = ampStatus.isCicatrized end
+    if ampStatus.isCauterized ~= nil then limbData.isCauterized = ampStatus.isCauterized end
+    if ampStatus.woundDirtyness ~= nil then limbData.woundDirtyness = ampStatus.woundDirtyness end
+    if ampStatus.isVisible ~= nil then limbData.isVisible = ampStatus.isVisible end
+
+    if cicatrizationTime ~= nil then limbData.cicatrizationTime = cicatrizationTime end
+end
+
+--* Update statuses of a limb *--
+
+---Decreases the cicatrization time
+---@param limbName string
+function DataController:decreaseCicatrizationTime(limbName)
+    self.tocData.limbs[limbName].cicatrizationTime = self.tocData.limbs[limbName].cicatrizationTime - 1
+end
+
+--* Global Mod Data Handling *--
+
+function DataController:apply()
+    ModData.transmit(CommandsData.GetKey(self.username))
+end
+
+function DataController.ReceiveData(key, data)
+    if not isClient() then
+        TOC_DEBUG.print("SP, skipping DataController.ReceiveData")
+    end
+    -- During startup the game can return Bob as the player username, adding a useless ModData table
+    if key == "TOC_Bob" then return end
+
+    TOC_DEBUG.print("[DataController] ReceiveData for " .. key)
+    if data == {} or data == nil then
+        TOC_DEBUG.print("table is nil... returning")
+        return
+    end
+
+    -- Get DataController instance if there was none for that user and reapply the correct ModData table as a reference
+    local username = key:sub(5)
+    local handler = DataController.GetInstance(username)
+    if handler.isResetForced or data == nil or data == {} or data == false then
+        TOC_DEBUG.print("[DataController] Setup")
+        handler:setup(key)
+        handler.isResetForced = false
+    else
+        TOC_DEBUG.print("[DataController] Reapply")
+        handler:reapplyTocData(data)
+    end
+
+
+    -- if handler.isResetForced or handler.tocData == nil or handler.tocData.limbs == nil or handler.tocData.limbs.Hand_L == nil or handler.tocData.limbs.Hand_L.isCut == nil then
+    --     TOC_DEBUG.print("tocData in DataController for " .. handler.username .. " is nil, creating it now")
+    --     handler:setup(key)
+    --     handler.isResetForced = false
+    -- elseif table then
+    --     TOC_DEBUG.print("Reapply toc data for " .. handler.username)
+    --     handler:reapplyTocData(table)
+    -- end
+
+    handler:setIsDataReady(true)
+
+    -- Event
+    triggerEvent("OnReceivedTocData", handler.username)
+
+    -- Transmit it to the server
+    ModData.transmit(key)
+    TOC_DEBUG.print("[DataController] Transmitting data after receiving it for: " .. handler.username)
+
+end
+
+Events.OnReceiveGlobalModData.Add(DataController.ReceiveData)
+
+-------------------
+
+---@param username string?
+---@return DataController
+function DataController.GetInstance(username)
+    if username == nil or username == "Bob" then
+        username = getPlayer():getUsername()
+    end
+
+    if DataController.instances[username] == nil then
+        TOC_DEBUG.print("[DataController] Creating NEW instance for " .. username)
+        return DataController:new(username)
+    else
+        return DataController.instances[username]
+    end
+end
+
+return DataController