2021-05-28 08:23:51 +02:00
|
|
|
|
2021-05-28 09:24:10 +02:00
|
|
|
--- World Data Manager API
|
2021-05-28 08:37:37 +02:00
|
|
|
--
|
|
|
|
-- @module api.lua
|
|
|
|
|
|
|
|
|
2021-05-28 08:23:51 +02:00
|
|
|
-- store formatted world path
|
|
|
|
local world_path = core.get_worldpath():gsub("\\", "/")
|
|
|
|
|
|
|
|
--- Retrieves directory path where file is located.
|
|
|
|
--
|
|
|
|
-- @local
|
2021-05-28 08:37:37 +02:00
|
|
|
-- @function get_dir
|
2021-05-28 08:23:51 +02:00
|
|
|
-- @tparam string fpath Full path to file.
|
|
|
|
-- @treturn string Full path to directory.
|
|
|
|
local function get_dir(fpath)
|
|
|
|
-- format to make working with easier
|
|
|
|
fpath = fpath:gsub("\\", "/")
|
|
|
|
local idx = fpath:find("/[^/]*$")
|
|
|
|
|
|
|
|
-- use world directory by default
|
|
|
|
if not idx or idx == 0 then
|
|
|
|
return world_path
|
|
|
|
end
|
|
|
|
|
|
|
|
return fpath:sub(1, idx-1)
|
|
|
|
end
|
|
|
|
|
|
|
|
|
|
|
|
--- Reads config file from world directory.
|
|
|
|
--
|
2021-05-28 09:24:10 +02:00
|
|
|
-- @function wdata.read
|
2021-05-28 08:23:51 +02:00
|
|
|
-- @tparam string fname Base filename with optional directory structure (e.g. "my_mod/my_config")
|
|
|
|
-- @treturn table Table with contents read from json file or `nil`.
|
2021-05-28 09:24:10 +02:00
|
|
|
function wdata.read(fname)
|
2021-05-28 08:23:51 +02:00
|
|
|
local fpath = world_path .. "/" .. fname .. ".json"
|
|
|
|
|
|
|
|
-- check if file exists
|
|
|
|
local fopen = io.open(fpath, "r")
|
|
|
|
if not fopen then
|
2021-05-28 09:24:10 +02:00
|
|
|
wdata.log("error", "file not found: " .. fpath)
|
2021-05-28 08:23:51 +02:00
|
|
|
return
|
|
|
|
end
|
|
|
|
|
|
|
|
local table_data = core.parse_json(fopen:read("*a"))
|
|
|
|
io.close(fopen)
|
|
|
|
|
|
|
|
if not table_data then
|
2021-05-28 09:24:10 +02:00
|
|
|
wdata.log("error", "cannot read json data from file: " .. fpath)
|
2021-05-28 08:23:51 +02:00
|
|
|
return
|
|
|
|
end
|
|
|
|
|
|
|
|
return table_data
|
|
|
|
end
|
|
|
|
|
|
|
|
|
|
|
|
--- Writes to config file in world directory.
|
|
|
|
--
|
2021-05-28 09:24:10 +02:00
|
|
|
-- @function wdata.write
|
2021-05-28 08:23:51 +02:00
|
|
|
-- @tparam string fname Base filename with optional directory structure (e.g. "my_mod/my_config").
|
|
|
|
-- @tparam table data Table data to be written to config file.
|
2021-05-28 08:44:07 +02:00
|
|
|
-- @tparam[opt] bool styled Outputs in a human-readable format if this is set (default: `true`).
|
2021-05-28 08:23:51 +02:00
|
|
|
-- @treturn bool `true` if succeeded, `false` if not.
|
2021-05-28 09:24:10 +02:00
|
|
|
function wdata.write(fname, data, styled)
|
2021-05-28 08:23:51 +02:00
|
|
|
styled = styled ~= false
|
|
|
|
|
|
|
|
local json_data = core.write_json(data, styled)
|
|
|
|
if not json_data then
|
2021-05-28 09:24:10 +02:00
|
|
|
wdata.log("error", "cannot convert data to json format")
|
2021-05-28 08:23:51 +02:00
|
|
|
return false
|
|
|
|
end
|
|
|
|
|
|
|
|
local fpath = world_path .. "/" .. fname .. ".json"
|
|
|
|
|
|
|
|
-- create directory tree if necessary
|
|
|
|
local dirname = get_dir(fpath)
|
|
|
|
if dirname ~= world_path then
|
|
|
|
if not core.mkdir(dirname) then
|
2021-05-28 09:24:10 +02:00
|
|
|
wdata.log("error", "cannot create directory: " .. dirname)
|
2021-05-28 08:23:51 +02:00
|
|
|
return false
|
|
|
|
end
|
|
|
|
end
|
|
|
|
|
|
|
|
return core.safe_file_write(fpath, json_data)
|
|
|
|
end
|
|
|
|
|
|
|
|
|
2021-05-28 08:37:37 +02:00
|
|
|
--- Aliases
|
|
|
|
--
|
|
|
|
-- @section aliases
|
|
|
|
|
2021-05-28 09:24:10 +02:00
|
|
|
--- Alias of `wdata.read`.
|
2021-05-28 08:37:37 +02:00
|
|
|
--
|
|
|
|
-- @falias minetest.read_world_config
|
2021-05-28 08:23:51 +02:00
|
|
|
if not core.read_world_config then
|
2021-05-28 09:24:10 +02:00
|
|
|
core.read_world_config = wdata.read
|
2021-05-28 08:23:51 +02:00
|
|
|
end
|
2021-05-28 08:37:37 +02:00
|
|
|
|
2021-05-28 09:24:10 +02:00
|
|
|
--- Alias of `wdata.write`.
|
2021-05-28 08:37:37 +02:00
|
|
|
--
|
|
|
|
-- @falias minetest.write_world_config
|
2021-05-28 08:23:51 +02:00
|
|
|
if not core.write_world_config then
|
2021-05-28 09:24:10 +02:00
|
|
|
core.write_world_config = wdata.write
|
2021-05-28 08:23:51 +02:00
|
|
|
end
|