MapGen: rewrite & add annotations

This commit is contained in:
Van
2025-08-30 14:12:19 +00:00
parent 8a54d3c48f
commit 704db1517d
6 changed files with 186 additions and 77 deletions

View File

@@ -1,19 +1,40 @@
local modInfo = Mod.getInfo()
local require = modInfo.require
local MapGenUtils = require("MapGen.Utils")
local Layer = require("MapGen.Layer")
local Region2D = require("MapGen.Region.Region2D")
local Region3D = require("MapGen.Region.Region3D")
local core, table, math = core, table, math
local ipairs = pairs, ipairs
-- Main MapGen class
local MapGen = {}
MapGen.__index = MapGen
local modInfo = Mod.getInfo()
local require = modInfo.require
---@type MapGen.Utils
local MapGenUtils = require("MapGen.Utils")
---@type MapGen.Layer
local Layer = require("MapGen.Layer")
---@type MapGen.Region.Region2D
local Region2D = require("MapGen.Region.Region2D")
---@type MapGen.Region.Region3D
local Region3D = require("MapGen.Region.Region3D")
---@class MapGen
---@field layersByName table
---@field layersList table
---@field registeredRegions table
---@field material table<string, number>
local MapGen = {
layersByName = nil,
layersList = nil,
registeredRegions = nil,
materials = {
impassableWater = nil,
impassableSeabed = nil,
air = nil,
},
}
---@return MapGen
function MapGen:new()
return setmetatable({
local instance = setmetatable({
layersByName = {},
layersList = {},
registeredRegions = {},
@@ -21,29 +42,58 @@ function MapGen:new()
impassableWater = core.get_content_id("impassable_water:water"),
impassableSeabed = core.get_content_id("impassable_water:seabed"),
air = core.get_content_id("air")
}
}, self)
},
}, {__index = self})
return instance
end
---@param name string
---@param minY number
---@param maxY number
---@return MapGen.Layer
function MapGen:registerLayer(name, minY, maxY)
---@type MapGen.Layer
local layer = Layer:new(name, minY, maxY)
self.layersByName[name] = layer
table.insert(self.layersList, layer)
return layer
end
---@param params table
function MapGen:register2DRegion(params)
---@type MapGen.Region.Region2D
local region = Region2D:new(params)
---@type MapGen.Layer
local layer = self.layersByName[params.layerName]
if not layer then error("Invalid layer: " .. params.layerName) end
if not layer then
error("Invalid layer: " .. params.layerName)
end
layer:add2DRegion(region)
-- TODO: тут не надо возвращать регион?
end
---@param params table
function MapGen:register3DRegion(params)
---@type MapGen.Region.Region3D
local region = Region3D:new(params)
---@type MapGen.Layer
local layer = self.layersByName[params.layerName]
if not layer then error("Invalid layer: " .. params.layerName) end
if not layer then
error("Invalid layer: " .. params.layerName)
end
layer:add3DRegion(region)
-- TODO: тут не надо возвращать регион?
end
function MapGen:enable()
@@ -52,7 +102,10 @@ function MapGen:enable()
end)
end
-- Main generation logic
--- Main generation logic
---@param minp table TODO: заменить тип на класс/вектор координат
---@param maxp table TODO: заменить тип на класс/вектор координат
---@param seed number
function MapGen:onMapGenerated(minp, maxp, seed)
local vm, emin, emax = core.get_mapgen_object("voxelmanip")
local area = VoxelArea:new{MinEdge=emin, MaxEdge=emax}
@@ -71,6 +124,9 @@ function MapGen:onMapGenerated(minp, maxp, seed)
vm:write_to_map()
end
---@param minp table TODO: заменить тип на класс/вектор координат
---@param maxp table TODO: заменить тип на класс/вектор координат
---@return table
function MapGen:process2DRegions(minp, maxp)
local cache = {}
local width = maxp.x - minp.x + 1
@@ -139,6 +195,11 @@ function MapGen:process2DRegions(minp, maxp)
return cache
end
---@param minp table TODO: заменить тип на класс/вектор координат
---@param maxp table TODO: заменить тип на класс/вектор координат
---@param data void TODO: какой тип?
---@param area void
---@param terrainCache void
function MapGen:process3DRegions(minp, maxp, data, area, terrainCache)
-- Precompute 3D noise for regions
local region3DNoise = {}

View File

@@ -1,39 +1,61 @@
local table, setmetatable = table, setmetatable
local Layer = {}
Layer.__index = Layer
---@class MapGen.Layer
---@field name string
---@field minY number
---@field maxY number
---@field regions2D MapGen.Region.Region2D[]
---@field regions3D MapGen.Region.Region3D[]
local Layer = {
name = nil,
minY = nil,
maxY = nil,
regions2D = nil,
regions3D = nil,
}
---@return MapGen.Layer
---@param name string
---@param minY number
---@param maxY number
---@return MapGen.Layer
function Layer:new(name, minY, maxY)
return setmetatable({
---@type MapGen.Layer
local instance = setmetatable({
name = name,
minY = minY,
maxY = maxY,
regions2D = {},
regions3D = {}
}, self)
}, {__index = self})
return instance
end
---@param region MapGen.Region.Region2D
function Layer:add2DRegion(region)
table.insert(self.regions2D, region)
end
---@param region MapGen.Region.Region3D
function Layer:add3DRegion(region)
table.insert(self.regions3D, region)
end
---@return boolean
function Layer:contains(x, y, z)
if y < self.minY or y > self.maxY then
return false
end
for _, region in ipairs(self.regions2D) do
if region:contains2D(x, z) then
if region:contains2D(x, z) then -- TODO: ТАКОГО МЕТОДА НИГДЕ НЕТ
return true
end
end
for _, region in ipairs(self.regions3D) do
if region:contains3D(x, y, z) then
if region:contains3D(x, y, z) then -- TODO: ТАКОГО МЕТОДА НИГДЕ НЕТ
return true
end
end

View File

@@ -1,14 +1,21 @@
local Region = {}
Region.__index = Region
local pairs, setmetatable = pairs, setmetatable
---@class MapGen.Region
local Region = {}
---@param params table
---@return MapGen.Region
function Region:new(params)
local instance = setmetatable({}, self)
---@type MapGen.Region
local instance = setmetatable({}, {__index = self})
for k, v in pairs(params) do
instance[k] = v
end
instance:initNoises()
return instance
end

View File

@@ -1,11 +1,15 @@
local modInfo = Mod.getInfo()
local Region = modInfo.require()("Region")
local core, setmetatable = core, setmetatable
-- 2D Region implementation
local Region2D = setmetatable({}, {__index = Region})
local modInfo = Mod.getInfo()
---@type MapGen.Region
local Region = modInfo.require("Region")
---@class MapGen.Region.Region2D : MapGen.Region
local Region2D = Api.getClassExtended(Region, {})
---@param params table
---@return MapGen.Region.Region2D
function Region2D:new(params)
local instance = Region.new(self, params)
instance.type = "2d"

View File

@@ -1,13 +1,17 @@
local modInfo = Mod.getInfo()
local Region = modInfo.require()("Region")
local core, setmetatable = core, setmetatable
-- 3D Region implementation
local Region3D = setmetatable({}, {__index = Region})
local modInfo = Mod.getInfo()
---@type MapGen.Region
local Region = modInfo.require("Region")
---@class MapGen.Region.Region3D : MapGen.Region
local Region3D = Api.getClassExtended(Region, {})
---@param params table
---@return MapGen.Region.Region3D
function Region3D:new(params)
local instance = Region.new(self, params)
local instance = Region:new(params)
instance.type = "3d"
return setmetatable(instance, {__index = Region3D})
end

View File

@@ -1,20 +1,31 @@
local math = math
-- Utility class with static methods
local MapGenUtils = {
calculateWeight = function(value, min, max)
--- Utility class with static methods
---@class MapGen.Utils
local Utils = {}
---@static
---@param value number
---@param min number
---@param max number
---@return number
function Utils.calculateWeight(value, min, max)
local center = (min + max) / 2
local span = (max - min) / 2
return 1 - math.abs((value - center) / span)
end,
---@return boolean
isInRange = function(value, range)
return 1 - math.abs((value - center) / span)
end
---@static
---@param value number
---@param range number
---@return boolean
function Utils.isInRange(value, range)
if value >= range.min and value <= range.max then
return true
end
return false
end
}
return MapGenUtils
return false
end
return Utils