Skip to content

Make tp tubes use mod storage with prefixed keys #179

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

Merged
wsor4035 merged 3 commits into from
Dec 25, 2025
Merged

Make tp tubes use mod storage with prefixed keys #179

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
68d922f
Make tp tubes use mod storage with prefixed keys
Watilin Nov 30, 2025
aeaf654
Move migration code to `migrate_tube_db`
Watilin Nov 30, 2025
379011f
Fix precision loss when converting hashes to string
Watilin Dec 1, 2025
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
44 changes: 32 additions & 12 deletions tubes/teleport.lua
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
local S = core.get_translator("pipeworks")
local filename = core.get_worldpath().."/teleport_tubes" -- Only used for backward-compat
local storage = core.get_mod_storage()
local STORAGE_PREFIX = "tptube_"

local enable_logging = core.settings:get_bool("pipeworks_log_teleport_tubes", false)

Expand Down Expand Up @@ -36,35 +37,51 @@ end

local function save_tube_db()
receiver_cache = {}
local fields = {version = tube_db_version}
storage:set_string("version", "") -- cleanup prefix-less entry
storage:set_int(STORAGE_PREFIX.."version", tube_db_version)
for key, val in pairs(tube_db) do
fields[key] = serialize_tube(val)
storage:set_string(key, "")
storage:set_string(
string.format("%s%.0f", STORAGE_PREFIX, key),
serialize_tube(val)
)
end
storage:from_table({fields = fields})
end

local function save_tube(hash)
local tube = tube_db[hash]
receiver_cache[tube.channel] = nil
storage:set_string(hash, serialize_tube(tube))
storage:set_string(
string.format("%s%.0f", STORAGE_PREFIX, hash),
serialize_tube(tube)
)
end

local function remove_tube(pos)
local hash = hash_pos(pos)
if tube_db[hash] then
receiver_cache[tube_db[hash].channel] = nil
tube_db[hash] = nil
storage:set_string(hash, "")
storage:set_string(string.format("%s%.0f", STORAGE_PREFIX, hash), "")
end
end

local function migrate_tube_db()
-- check prefix-less version number
if storage:get_int("version") == 4 then
for key, val in pairs(storage:to_table().fields) do
if tonumber(key) then
tube_db[key] = deserialize_tube(key, val)
end
-- ignore other keys
end
save_tube_db()
return
end
if storage:get_int("version") == 3 then
for key, val in pairs(storage:to_table().fields) do
if tonumber(key) then
tube_db[key] = core.deserialize(val)
elseif key ~= "version" then
error("Unknown field in teleport tube database: "..key)
end
end
save_tube_db()
Expand Down Expand Up @@ -93,17 +110,20 @@ local function migrate_tube_db()
end

local function read_tube_db()
local version = storage:get_int("version")
local version = storage:get_int(STORAGE_PREFIX.."version")
if version < tube_db_version then
migrate_tube_db()
elseif version > tube_db_version then
error("Cannot read teleport tube database of version "..version)
else
for key, val in pairs(storage:to_table().fields) do
if tonumber(key) then
tube_db[key] = deserialize_tube(key, val)
elseif key ~= "version" then
error("Unknown field in teleport tube database: "..key)
local short_key = string.match(key, "^"..STORAGE_PREFIX.."(.+)")
if short_key then -- only handle keys relevant to tp tubes
if tonumber(short_key) then
tube_db[short_key] = deserialize_tube(short_key, val)
elseif short_key ~= "version" then
error("Unknown field in teleport tube database: "..short_key)
end
end
end
end
Expand Down