MapGen: add StaticLayer
This commit is contained in:
@@ -24,6 +24,9 @@ local require = modInfo.require
|
||||
---@type MapGen.Layer
|
||||
local Layer = require('MapGen.Layer')
|
||||
|
||||
---@type MapGen.StaticLayer
|
||||
local StaticLayer = require('MapGen.StaticLayer')
|
||||
|
||||
---@type MapGen.Peak
|
||||
local Peak = require('MapGen.Peak')
|
||||
|
||||
@@ -39,6 +42,8 @@ local Cavern = require('MapGen.Cavern')
|
||||
---@class MapGen
|
||||
---@field layersByName table<string, MapGen.Layer>
|
||||
---@field layersList MapGen.Layer[]
|
||||
---@field staticsByName table<string, MapGen.StaticLayer>
|
||||
---@field staticsList MapGen.StaticLayer[]
|
||||
---@field peaksMultinoiseInitialized boolean Is the fractal noise of the peaks initialized? This is necessary for a one-time noise initialization.
|
||||
---@field cavernsNoiseInitialized boolean Is the fractal noise of the caverns initialized? This is necessary for a one-time noise initialization.
|
||||
---@field isRunning boolean A static field that guarantees that only one instance of the `MapGen` class will work.
|
||||
@@ -47,9 +52,11 @@ local Cavern = require('MapGen.Cavern')
|
||||
local MapGen = {
|
||||
layersByName = {},
|
||||
layersList = {},
|
||||
staticsByName = {},
|
||||
staticsList = {},
|
||||
peaksMultinoiseInitialized = false,
|
||||
cavernsNoiseInitialized = false,
|
||||
isRunning = false,
|
||||
cavernsNoiseInitialized = false,
|
||||
isRunning = false,
|
||||
}
|
||||
|
||||
---@class MapGenDef
|
||||
@@ -94,6 +101,25 @@ function MapGen:getLayerByHeight(yPos)
|
||||
end
|
||||
end
|
||||
|
||||
---Determines which statics layer a node belongs to based on its height coordinate.
|
||||
---@param yPos number
|
||||
---@return MapGen.StaticLayer?
|
||||
function MapGen:getStaticByHeight(yPos)
|
||||
--- TODO: возможно здесь получится сделать более оптимизированный алгоритм
|
||||
--- учитывая тот факт, что эта функция вызывается для каждой ноды в on_generated
|
||||
--- и может быть даже не один раз
|
||||
--- Можно подумать над тем, чтобы использовать сортированный список
|
||||
|
||||
---@param static MapGen.StaticLayer
|
||||
for _, static in ipairs(self.staticsList) do
|
||||
|
||||
if yPos >= static.minY and yPos <= static.maxY then
|
||||
return static
|
||||
end
|
||||
|
||||
end
|
||||
end
|
||||
|
||||
|
||||
|
||||
-- --- REGISTRATION METHODS ---
|
||||
@@ -103,7 +129,7 @@ end
|
||||
---Note: layers must not overlap.
|
||||
---@param name string The name that will be assigned to the layer. The name must be unique for each layer.
|
||||
---@param def MapGen.LayerDef Layer description table, see details `MapGen.LayerDef`
|
||||
function MapGen:RegisterLayer(name, def)
|
||||
function MapGen:registerLayer(name, def)
|
||||
-- Layers with the same name cannot exist.
|
||||
assert(self.layersByName[name] == nil, ('A layer named `%s` is already registered.'):format(name))
|
||||
|
||||
@@ -116,12 +142,36 @@ function MapGen:RegisterLayer(name, def)
|
||||
self.layersByName[name] = layer
|
||||
table.insert(self.layersList, layer)
|
||||
|
||||
-- Sort layers by maxY descending for processing priority
|
||||
-- Sort layers by maxY descending for processing priority.
|
||||
table.sort(self.layersList, function(a, b)
|
||||
return a.maxY > b.maxY
|
||||
end)
|
||||
end
|
||||
|
||||
---Mark the world area between two heights as a `MapGen.StaticLayer`.
|
||||
---
|
||||
---Note: layers must not overlap.
|
||||
---@param name string The name that will be assigned to the static layer. The name must be unique for each layer.
|
||||
---@param def MapGen.StaticLayerDef Static layer description table, see details `MapGen.StaticLayerDef`
|
||||
function MapGen:registerStaticLayer(name, def)
|
||||
-- Static layer with the same name cannot exist.
|
||||
assert(self.staticsByName[name] == nil, ('A static layer named `%s` is already registered.'):format(name))
|
||||
|
||||
-- Static layers cannot overlap.
|
||||
assert(self:getStaticByHeight(def.minY) == nil and self:getLayerByHeight(def.maxY) == nil, 'Registered static layers must not overlap!')
|
||||
|
||||
---@type MapGen.StaticLayer
|
||||
local static = StaticLayer:new(name, def)
|
||||
|
||||
self.staticsByName[name] = static
|
||||
table.insert(self.staticsList, static)
|
||||
|
||||
-- Sort srtatics by maxY descending for processing priority.
|
||||
table.sort(self.staticsList, function(a, b)
|
||||
return a.maxY > b.maxY
|
||||
end)
|
||||
end
|
||||
|
||||
---Mark a world point as `MapGen.Peak` and assign it a specific noise that will affect the generation.
|
||||
---
|
||||
---Note: The peaks shouldn't overlap. This won't cause any errors, but it might ruin the generation.
|
||||
@@ -328,33 +378,33 @@ local function generateNode(mapGenerator, layer, height, temp, humidity, data, i
|
||||
-- If the block is above surface height and above water level...
|
||||
if y > height and y > waterLevel then
|
||||
-- ... then airspace is generated.
|
||||
biome.generateAir(mapGenerator, biome, data, index, x, y, z)
|
||||
biome:generateAir(mapGenerator, data, index, x, y, z)
|
||||
|
||||
-- If the block is above the surface height BUT below the water level...
|
||||
elseif y > height and y <= waterLevel then
|
||||
-- ... then underwater space is generated.
|
||||
biome.generateWater(mapGenerator, biome, data, index, x, y, z)
|
||||
biome:generateWater(mapGenerator, data, index, x, y, z)
|
||||
|
||||
-- If the block is below the surface height...
|
||||
elseif y <= height then
|
||||
-- ... and a cavern is generated in the block...
|
||||
if isCavern(layer, x, y, z) then
|
||||
-- ... then airspace is generated.
|
||||
biome.generateCavernAir(mapGenerator, biome, data, index, x, y, z)
|
||||
biome:generateCavernAir(mapGenerator, data, index, x, y, z)
|
||||
|
||||
-- ... or if the surface height is above the water level...
|
||||
elseif height > waterLevel then
|
||||
--- ... and the height of the block is equal to the height of the surface...
|
||||
if y == height then
|
||||
-- ... then turf is generated.
|
||||
biome.generateTurf(mapGenerator, biome, data, index, x, y, z)
|
||||
biome:generateTurf(mapGenerator, data, index, x, y, z)
|
||||
-- ... or if the height of the block falls within the thickness of the soil layer...
|
||||
elseif y > height - biome.soilHeight then
|
||||
-- ... then soil is generated.
|
||||
biome.generateSoil(mapGenerator, biome, data, index, x, y, z)
|
||||
biome:generateSoil(mapGenerator, data, index, x, y, z)
|
||||
else
|
||||
-- ... else e a stone is generated.
|
||||
biome.generateRock(mapGenerator, biome, data, index, x, y, z)
|
||||
biome:generateRock(mapGenerator, data, index, x, y, z)
|
||||
end
|
||||
|
||||
-- ... or if the surface height is below the water level...
|
||||
@@ -362,10 +412,10 @@ local function generateNode(mapGenerator, layer, height, temp, humidity, data, i
|
||||
-- ... and if the height of the block falls within the thickness of the soil layer...
|
||||
if y > height - biome.soilHeight then
|
||||
-- ... then the river/ocean bottom is generated.
|
||||
biome.generateBottom(mapGenerator, biome, data, index, x, y, z)
|
||||
biome:generateBottom(mapGenerator, data, index, x, y, z)
|
||||
else
|
||||
-- ... else a stone is generated.
|
||||
biome.generateRock(mapGenerator, biome, data, index, x, y, z)
|
||||
biome:generateRock(mapGenerator, data, index, x, y, z)
|
||||
end
|
||||
end
|
||||
else
|
||||
@@ -623,6 +673,14 @@ end
|
||||
---@param y number
|
||||
---@param z number
|
||||
local function generatorHandler(mapGenerator, data, index, x, y, z)
|
||||
-- If the node belongs to a static layer, then a static node is generated.
|
||||
local static = mapGenerator:getStaticByHeight(y)
|
||||
if static ~= nil then
|
||||
static:generateStaticNode(mapGenerator, data, index, x, y, z)
|
||||
|
||||
return
|
||||
end
|
||||
|
||||
-- If generation occurs outside the layers, then a void is generated.
|
||||
local layer = mapGenerator:getLayerByHeight(y)
|
||||
if layer == nil then
|
||||
|
||||
@@ -18,7 +18,7 @@ local id = core.get_content_id
|
||||
---@field generateBottom generateFunc
|
||||
local Biome = {}
|
||||
|
||||
---@alias generateFunc fun(mapGenerator:MapGen, biome:MapGen.Biome, data:number[], index:number, x:number, y:number, z:number)
|
||||
---@alias generateFunc fun(self, mapGenerator:MapGen, data:number[], index:number, x:number, y:number, z:number)
|
||||
|
||||
---Definition table for the `MapGen.Biome`.
|
||||
---
|
||||
@@ -41,81 +41,81 @@ local Biome = {}
|
||||
|
||||
-- Default generate functions
|
||||
|
||||
---@param self MapGen.Biome
|
||||
---@param mapGenerator MapGen
|
||||
---@param biome MapGen.Biome
|
||||
---@param data number[]
|
||||
---@param index number
|
||||
---@param x number
|
||||
---@param y number
|
||||
---@param z number
|
||||
local defaultGenerateAir = function(mapGenerator, biome, data, index, x, y, z)
|
||||
local defaultGenerateAir = function(self, mapGenerator, data, index, x, y, z)
|
||||
data[index] = mapGenerator.nodeIDs.air
|
||||
end
|
||||
|
||||
---@param self MapGen.Biome
|
||||
---@param mapGenerator MapGen
|
||||
---@param biome MapGen.Biome
|
||||
---@param data number[]
|
||||
---@param index number
|
||||
---@param x number
|
||||
---@param y number
|
||||
---@param z number
|
||||
local defaultGenerateCavernAir = function(mapGenerator, biome, data, index, x, y, z)
|
||||
biome.generateAir(mapGenerator, biome, data, index, x, y, z)
|
||||
local defaultGenerateCavernAir = function(self, mapGenerator, data, index, x, y, z)
|
||||
self:generateAir(mapGenerator, data, index, x, y, z)
|
||||
end
|
||||
|
||||
---@param self MapGen.Biome
|
||||
---@param mapGenerator MapGen
|
||||
---@param biome MapGen.Biome
|
||||
---@param data number[]
|
||||
---@param index number
|
||||
---@param x number
|
||||
---@param y number
|
||||
---@param z number
|
||||
local defaultGenerateWater = function(mapGenerator, biome, data, index, x, y, z)
|
||||
local defaultGenerateWater = function(self, mapGenerator, data, index, x, y, z)
|
||||
data[index] = mapGenerator.nodeIDs.water
|
||||
end
|
||||
|
||||
---@param self MapGen.Biome
|
||||
---@param mapGenerator MapGen
|
||||
---@param biome MapGen.Biome
|
||||
---@param data number[]
|
||||
---@param index number
|
||||
---@param x number
|
||||
---@param y number
|
||||
---@param z number
|
||||
local defaultGenerateRock = function(mapGenerator, biome, data, index, x, y, z)
|
||||
data[index] = biome.groundNodesIDs.rock
|
||||
local defaultGenerateRock = function(self, mapGenerator, data, index, x, y, z)
|
||||
data[index] = self.groundNodesIDs.rock
|
||||
end
|
||||
|
||||
---@param self MapGen.Biome
|
||||
---@param mapGenerator MapGen
|
||||
---@param biome MapGen.Biome
|
||||
---@param data number[]
|
||||
---@param index number
|
||||
---@param x number
|
||||
---@param y number
|
||||
---@param z number
|
||||
local defaultGenerateTurf = function(mapGenerator, biome, data, index, x, y, z)
|
||||
data[index] = biome.groundNodesIDs.turf
|
||||
local defaultGenerateTurf = function(self, mapGenerator, data, index, x, y, z)
|
||||
data[index] = self.groundNodesIDs.turf
|
||||
end
|
||||
|
||||
---@param self MapGen.Biome
|
||||
---@param mapGenerator MapGen
|
||||
---@param biome MapGen.Biome
|
||||
---@param data number[]
|
||||
---@param index number
|
||||
---@param x number
|
||||
---@param y number
|
||||
---@param z number
|
||||
local defaultGenerateSoil = function(mapGenerator, biome, data, index, x, y, z)
|
||||
data[index] = biome.groundNodesIDs.soil
|
||||
local defaultGenerateSoil = function(self, mapGenerator,data, index, x, y, z)
|
||||
data[index] = self.groundNodesIDs.soil
|
||||
end
|
||||
|
||||
---@param self MapGen.Biome
|
||||
---@param mapGenerator MapGen
|
||||
---@param biome MapGen.Biome
|
||||
---@param data number[]
|
||||
---@param index number
|
||||
---@param x number
|
||||
---@param y number
|
||||
---@param z number
|
||||
local defaultGenerateBottom = function(mapGenerator, biome, data, index, x, y, z)
|
||||
data[index] = biome.groundNodesIDs.bottom
|
||||
local defaultGenerateBottom = function(self, mapGenerator, data, index, x, y, z)
|
||||
data[index] = self.groundNodesIDs.bottom
|
||||
end
|
||||
|
||||
|
||||
|
||||
58
mods/CORE/MapGen/src/MapGen/StaticLayer.lua
Normal file
58
mods/CORE/MapGen/src/MapGen/StaticLayer.lua
Normal file
@@ -0,0 +1,58 @@
|
||||
local id = core.get_content_id
|
||||
|
||||
---@class MapGen.StaticLayer
|
||||
---@field name string
|
||||
---@field minY number
|
||||
---@field maxY number
|
||||
---@field staticNode string
|
||||
---@field staticNodeID number
|
||||
---@field generateStaticNode generateFunc
|
||||
local StaticLayer = {}
|
||||
|
||||
---Definition table for the `MapGen.StaticLayer`.
|
||||
---
|
||||
---**Only for EmmyLua.**
|
||||
---@class MapGen.StaticLayerDef
|
||||
---@field minY number
|
||||
---@field maxY number
|
||||
---@field staticNode string
|
||||
---@field generateStaticNode generateFunc
|
||||
|
||||
---@param self MapGen.StaticLayer
|
||||
---@param mapGenerator MapGen
|
||||
---@param data number[]
|
||||
---@param index number
|
||||
---@param x number
|
||||
---@param y number
|
||||
---@param z number
|
||||
local defaultGenerateStaticNode = function(self, mapGenerator, data, index, x, y, z)
|
||||
data[index] = self.staticNodeID
|
||||
end
|
||||
|
||||
---@param name string
|
||||
---@param def MapGen.StaticLayerDef
|
||||
---@return MapGen.StaticLayer
|
||||
function StaticLayer:new(name, def)
|
||||
assert(def.maxY > def.minY, 'maxY there should be more minY')
|
||||
|
||||
if def.generateStaticNode == nil then
|
||||
Logger.infoLog('MapGen.StaticLayer: The `%s` static layer does not have a specified `generateStaticNode()` function. The default function is used.', name)
|
||||
def.generateStaticNode = defaultGenerateStaticNode
|
||||
end
|
||||
|
||||
local staticNodeID = id(def.staticNode)
|
||||
|
||||
---@type MapGen.StaticLayer
|
||||
local instance = setmetatable({
|
||||
name = name,
|
||||
minY = def.minY,
|
||||
maxY = def.maxY,
|
||||
staticNode = def.staticNode,
|
||||
staticNodeID = staticNodeID,
|
||||
generateStaticNode = def.generateStaticNode
|
||||
}, {__index = self})
|
||||
|
||||
return instance
|
||||
end
|
||||
|
||||
return StaticLayer
|
||||
@@ -79,7 +79,7 @@ local function calcHumidity(layer, value, height)
|
||||
return value
|
||||
end
|
||||
|
||||
mapGenerator:RegisterLayer("world", {
|
||||
mapGenerator:registerLayer("world", {
|
||||
minY = -50,
|
||||
maxY = 50,
|
||||
minTemp = 0,
|
||||
@@ -208,7 +208,7 @@ local rocksNoiseParams ={
|
||||
lacunarity = 4,
|
||||
}
|
||||
|
||||
local function generateRock(mapGenerator, biome, data, index, x, y, z)
|
||||
local function generateRock(biome, mapGenerator, data, index, x, y, z)
|
||||
local ids = mapGenerator.nodeIDs
|
||||
|
||||
if rocksNoise == nil then
|
||||
@@ -235,7 +235,7 @@ local function generateRock(mapGenerator, biome, data, index, x, y, z)
|
||||
end
|
||||
end
|
||||
|
||||
local function generateSoil(mapGenerator, biome, data, index, x, y, z)
|
||||
local function generateSoil(biome, mapGenerator, data, index, x, y, z)
|
||||
data[index] = biome.groundNodesId.turf
|
||||
end
|
||||
|
||||
|
||||
Reference in New Issue
Block a user