Skip to content

fix: use default capacity if savegame value is invalid #22

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
snorrelo wants to merge 1 commit into
base: main
Choose a base branch
from
Open

fix: use default capacity if savegame value is invalid #22

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions scripts/RmAdjustStorageCapacity.lua
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,6 +78,13 @@ function RmAdjustStorageCapacity.clampToMax(value)
return value, false
end

--- Check if value is valid.
---@param value any Value parsed from the savegame (XMLValueType.INT -> number/nil/other)
---@return boolean valid True when value is a number in [0, MAX_CAPACITY]
function RmAdjustStorageCapacity.isStoredCapacityValid(value)
return type(value) == "number" and value >= 0 and value <= RmAdjustStorageCapacity.MAX_CAPACITY
end

-- ============================================================================
-- Storage Enumeration and Type Detection
-- ============================================================================
Expand Down
36 changes: 25 additions & 11 deletions scripts/placeables/RmPlaceableStorageCapacity.lua
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -137,30 +137,44 @@ function RmPlaceableStorageCapacity:onLoad(savegame)
local name = xmlFile:getValue(ftKey .. "#name")
local capacity = xmlFile:getValue(ftKey .. "#capacity")
if name and capacity then
-- Defensive [0, MAX] clamp: heal a pre-fix / hand-edited save (over-max or wrapped-negative).
capacity = math.max(0, (RmAdjustStorageCapacity.clampToMax(capacity)))
local fillTypeIndex = g_fillTypeManager:getFillTypeIndexByName(name)
if fillTypeIndex then
entry.fillTypes[fillTypeIndex] = capacity
Log:debug("LOAD_SAVEGAME: Read fillType %s = %d", name, capacity)
-- Check if the parsed capacity is valid. If not, keep the engine default
if not RmAdjustStorageCapacity.isStoredCapacityValid(capacity) then
Log:warning("LOAD_SAVEGAME: %s dropped corrupt fillType '%s' capacity (parsed %s) - keeping engine default",
placeableName, name, tostring(capacity))
else
Log:warning("LOAD_SAVEGAME: Unknown fill type '%s' in savegame", name)
local fillTypeIndex = g_fillTypeManager:getFillTypeIndexByName(name)
if fillTypeIndex then
entry.fillTypes[fillTypeIndex] = capacity
Log:debug("LOAD_SAVEGAME: Read fillType %s = %d", name, capacity)
else
Log:warning("LOAD_SAVEGAME: Unknown fill type '%s' in savegame", name)
end
end
end
end)

-- Read husbandry food capacity
entry.husbandryFood = xmlFile:getValue(modKey .. ".husbandryFood#capacity")
if entry.husbandryFood then
entry.husbandryFood = math.max(0, (RmAdjustStorageCapacity.clampToMax(entry.husbandryFood)))
Log:debug("LOAD_SAVEGAME: Read husbandryFood = %d", entry.husbandryFood)
if not RmAdjustStorageCapacity.isStoredCapacityValid(entry.husbandryFood) then
Log:warning("LOAD_SAVEGAME: %s dropped corrupt husbandryFood capacity (parsed %s) - keeping engine default",
placeableName, tostring(entry.husbandryFood))
entry.husbandryFood = nil
else
Log:debug("LOAD_SAVEGAME: Read husbandryFood = %d", entry.husbandryFood)
end
end

-- Read shared capacity
entry.sharedCapacity = xmlFile:getValue(modKey .. ".sharedCapacity#value")
if entry.sharedCapacity then
entry.sharedCapacity = math.max(0, (RmAdjustStorageCapacity.clampToMax(entry.sharedCapacity)))
Log:debug("LOAD_SAVEGAME: Read sharedCapacity = %d", entry.sharedCapacity)
if not RmAdjustStorageCapacity.isStoredCapacityValid(entry.sharedCapacity) then
Log:warning("LOAD_SAVEGAME: %s dropped corrupt sharedCapacity (parsed %s) - keeping engine default",
placeableName, tostring(entry.sharedCapacity))
entry.sharedCapacity = nil
else
Log:debug("LOAD_SAVEGAME: Read sharedCapacity = %d", entry.sharedCapacity)
end
end

-- Apply if we have data
Expand Down
12 changes: 8 additions & 4 deletions scripts/vehicles/RmVehicleStorageCapacity.lua
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -393,10 +393,14 @@ function RmVehicleStorageCapacity:onLoad(savegame)
local index = xmlFile:getValue(fuKey .. "#index")
local capacity = xmlFile:getValue(fuKey .. "#capacity")
if index and capacity then
-- Defensive [0, MAX] clamp: heal a pre-fix / hand-edited save (over-max or wrapped-negative).
capacity = math.max(0, (RmAdjustStorageCapacity.clampToMax(capacity)))
entry[index] = capacity
Log:debug("LOAD_SAVEGAME: Read fillUnit %d = %d", index, capacity)
-- Check if the parsed capacity is valid. If not, keep the engine default.
if not RmAdjustStorageCapacity.isStoredCapacityValid(capacity) then
Log:warning("LOAD_SAVEGAME: %s dropped corrupt fillUnit[%s] capacity (parsed %s) - keeping engine default",
vehicleName, tostring(index), tostring(capacity))
else
entry[index] = capacity
Log:debug("LOAD_SAVEGAME: Read fillUnit %d = %d", index, capacity)
end
end
end)

Expand Down