MapGen: add draft tree generation

This commit is contained in:
Van
2026-06-14 21:01:38 +03:00
parent 9252cf429c
commit ce38f752f7
8 changed files with 470 additions and 213 deletions

View File

@@ -44,22 +44,30 @@ local Biome = require('MapGen.Biome')
local Cavern = require('MapGen.Cavern')
---@type MapGen.Region
local Region = require('MapGen.Region')
---@type MapGen.Tree
local Tree = require('MapGen.Tree')
---@class MapGen
---@field layersByName table<string, MapGen.Layer>
---@field layersList MapGen.Layer[]
---@field staticsByName table<string, MapGen.StaticLayer>
---@field staticsList MapGen.StaticLayer[]
---@field layersByName table<string, MapGen.Layer>
---@field layersList MapGen.Layer[]
---
---@field staticsByName table<string, MapGen.StaticLayer>
---@field staticsList MapGen.StaticLayer[]
---
---@field treesByName table<string, MapGen.Tree>
---
---@field isLayersNoisesInitialized boolean Is the fractal noise of the layer initialized? This is necessary for a one-time noise initialization.
---@field isCavernsNoiseInitialized 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.
---@field nodes table<string, string>
---@field nodeIDs table<string, number>
---
---@field nodes table<string, string>
---@field nodeIDs table<string, number>
local MapGen = {
layersByName = {},
layersList = {},
staticsByName = {},
staticsList = {},
treesByName = {},
isLayersNoisesInitialized = false,
isCavernsNoiseInitialized = false,
isRunning = false,
@@ -87,6 +95,8 @@ function MapGen:new(def)
return instance
end
-- --- API METHODS ---
---Returns a layer by name. If such a layer does not exist, an error will be raised.
---@param layerName string The name of the layer to be retrieved.
---@return MapGen.Layer
@@ -147,6 +157,184 @@ function MapGen:getPeakByPos(layer, pos)
return layer:getPeakByPos(pos)
end
---Checks if a point is inside a region.
---
---If the point is inside the region, it will also return the distance to the nearest border.
---@param layer MapGen.Layer The name of the layer in which the region is located.
---@param regionName string The name of the region in which the location of the point is checked.
---@param point MapVector Point position.
---@return boolean, number?
function MapGen:pointInRegion2D(layer, regionName, point)
local region = layer.regionsByName[regionName]
assert(region ~= nil, ('There is no region named `%s` registered.'):format(regionName))
return region:pointInRegion(point)
end
---Returns `true` if there is a cavern at the specified coordinates.
---@param layer MapGen.Layer
---@param x integer
---@param y integer
---@param z integer
---@return boolean
function MapGen:isCavern(layer, x, y, z)
for _, cavern in ipairs(layer.cavernsList) do
if cavern.isRegional then
local inRegion, distance = self:pointInRegion2D(layer, cavern.name, v(x, y, z))
if inRegion and distance ~= nil then
if cavern:isCavern(x, y, z, distance) then
return true
end
end
else
if cavern:isLayeredCavern(x, y, z) then
return true
end
end
end
return false
end
---@param name string
---@return MapGen.Tree
function MapGen:getTree(name)
assert(self.treesByName[name] ~= nil, ('There is no tree named `%s` registered.'):format(name))
return self.treesByName[name]
end
-- --- API METHODS: REGISTRATION ---
---Mark the world area between two heights as a `MapGen.Layer`.
---
---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)
-- Layers with the same name cannot exist.
assert(self.layersByName[name] == nil, ('A layer named `%s` is already registered.'):format(name))
-- Layers cannot overlap.
assert(self:getLayerByHeight(def.minY) == nil and self:getLayerByHeight(def.maxY) == nil, 'Registered layers must not overlap!')
---@type MapGen.Layer
local layer = Layer:new(name, def)
self.layersByName[name] = layer
tableInsert(self.layersList, layer)
pastNoiseValues[name] = {}
-- Sort layers by maxY descending for processing priority.
table.sort(self.layersList, function(a, b)
return a.maxY > b.maxY
end)
end
---Register the color and the noise parameters that correspond to it.
---@param layerName string The name of the layer for which the color will be registered.
---@param category MapGen.Layer.Category Category indicating what will be generated by noise.
---@param color ColorString Noise color. Must be unique.
---@param noiseParams NoiseParams Fractal noise parameters.
function MapGen:registerLayerNoiseColor(layerName, category, color, noiseParams)
local layer = self:getLayerByName(layerName)
layer:addNoiseParamsColor(category, color, noiseParams)
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
tableInsert(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 point on the biomes diagram and constrain the world area by height to mark it as `MapGen.Biome`.
---@param layerName string The name of the layer in which the new biome will be included.
---@param biomeName string The name to be assigned to the biome. The name must be unique for each biome.
---@param def MapGen.BiomeDef Biome description table, see details `MapGen.BiomeDef`
function MapGen:registerBiome(layerName, biomeName, def)
local layer = self:getLayerByName(layerName)
local biome = Biome:new(biomeName, def)
layer:addBiome(biomeName, biome)
end
---Mark the world area between two heights as a `MapGen.Cavern` and assign the noise that the cave will be generated from.
---@param layerName string The name of the layer in which the new cavern will be included.
---@param cavernName string The name to be assigned to the cavern. The name must be unique for each cavern.
---@param def MapGen.CavernDef Cavern description table, see details `MapGen.CavernDef`
---@param regionVertices MapVector[]? The region to which the cave generation will be limited.
function MapGen:registerCavern(layerName, cavernName, def, regionVertices)
local layer = self:getLayerByName(layerName)
if regionVertices ~= nil then
self:registerRegion(layerName, cavernName, {
vertices = regionVertices
})
def.isRegional = true
end
local cavern = Cavern:new(cavernName, def)
layer:addCavern(cavernName, cavern)
end
---Mark the world region between the vertices as `MapGen.Region` and give it a name.
---@param layerName string The name of the layer in which the new region will be included.
---@param regionName string The name to be assigned to the region. The name must be unique for each region.
---@param def MapGen.RegionDef Region description table, see details `MapGen.RegionDef`
function MapGen:registerRegion(layerName, regionName, def)
if regionName == 'landscape_boundary' or
regionName == 'temp_boundary' or
regionName == 'humidity_boundary' then
error(('The name `%s` is reserved for special regions and cannot be used.'):format(regionName))
end
local layer = self:getLayerByName(layerName)
local region = Region:new(regionName, def)
layer:addRegion(regionName, region)
end
---@param name string
---@param def MapGen.TreeDef
function MapGen:registerTree(name, def)
assert(self.treesByName[name] == nil, ('A tree named `%s` is already registered.'):format(name))
local tree = Tree:new(name, def)
self.treesByName[name] = tree
end
-- --- HELPER METHODS ---
---Checks if a point is inside a triangle using the vector product method.
---
---If the point is inside the triangle, it will return the triangle itself;
@@ -212,47 +400,6 @@ function MapGen:findTriangle(layer, x, z, triangle)
return triangle
end
---Checks if a point is inside a region.
---
---If the point is inside the region, it will also return the distance to the nearest border.
---@param layer MapGen.Layer The name of the layer in which the region is located.
---@param regionName string The name of the region in which the location of the point is checked.
---@param point MapVector Point position.
---@return boolean, number?
function MapGen:pointInRegion2D(layer, regionName, point)
local region = layer.regionsByName[regionName]
assert(region ~= nil, ('There is no region named `%s` registered.'):format(regionName))
return region:pointInRegion(point)
end
---Returns `true` if there is a cavern at the specified coordinates.
---@param layer MapGen.Layer
---@param x integer
---@param y integer
---@param z integer
---@return boolean
function MapGen:isCavern(layer, x, y, z)
for _, cavern in ipairs(layer.cavernsList) do
if cavern.isRegional then
local inRegion, distance = self:pointInRegion2D(layer, cavern.name, v(x, y, z))
if inRegion and distance ~= nil then
if cavern:isCavern(x, y, z, distance) then
return true
end
end
else
if cavern:isLayeredCavern(x, y, z) then
return true
end
end
end
return false
end
---Creates a unique key for a vertex (using X and Z coordinates).
---@param peak MapGen.Peak
---@return string
@@ -376,122 +523,6 @@ end
-- --- REGISTRATION METHODS ---
---Mark the world area between two heights as a `MapGen.Layer`.
---
---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)
-- Layers with the same name cannot exist.
assert(self.layersByName[name] == nil, ('A layer named `%s` is already registered.'):format(name))
-- Layers cannot overlap.
assert(self:getLayerByHeight(def.minY) == nil and self:getLayerByHeight(def.maxY) == nil, 'Registered layers must not overlap!')
---@type MapGen.Layer
local layer = Layer:new(name, def)
self.layersByName[name] = layer
tableInsert(self.layersList, layer)
pastNoiseValues[name] = {}
-- Sort layers by maxY descending for processing priority.
table.sort(self.layersList, function(a, b)
return a.maxY > b.maxY
end)
end
---Register the color and the noise parameters that correspond to it.
---@param layerName string The name of the layer for which the color will be registered.
---@param category MapGen.Layer.Category Category indicating what will be generated by noise.
---@param color ColorString Noise color. Must be unique.
---@param noiseParams NoiseParams Fractal noise parameters.
function MapGen:registerLayerNoiseColor(layerName, category, color, noiseParams)
local layer = self:getLayerByName(layerName)
layer:addNoiseParamsColor(category, color, noiseParams)
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
tableInsert(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 point on the biomes diagram and constrain the world area by height to mark it as `MapGen.Biome`.
---@param layerName string The name of the layer in which the new biome will be included.
---@param biomeName string The name to be assigned to the biome. The name must be unique for each biome.
---@param def MapGen.BiomeDef Biome description table, see details `MapGen.BiomeDef`
function MapGen:registerBiome(layerName, biomeName, def)
local layer = self:getLayerByName(layerName)
local biome = Biome:new(biomeName, def)
layer:addBiome(biomeName, biome)
end
---Mark the world area between two heights as a `MapGen.Cavern` and assign the noise that the cave will be generated from.
---@param layerName string The name of the layer in which the new cavern will be included.
---@param cavernName string The name to be assigned to the cavern. The name must be unique for each cavern.
---@param def MapGen.CavernDef Cavern description table, see details `MapGen.CavernDef`
---@param regionVertices MapVector[]? The region to which the cave generation will be limited.
function MapGen:registerCavern(layerName, cavernName, def, regionVertices)
local layer = self:getLayerByName(layerName)
if regionVertices ~= nil then
self:registerRegion(layerName, cavernName, {
vertices = regionVertices
})
def.isRegional = true
end
local cavern = Cavern:new(cavernName, def)
layer:addCavern(cavernName, cavern)
end
---Mark the world region between the vertices as `MapGen.Region` and give it a name.
---@param layerName string The name of the layer in which the new region will be included.
---@param regionName string The name to be assigned to the region. The name must be unique for each region.
---@param def MapGen.RegionDef Region description table, see details `MapGen.RegionDef`
function MapGen:registerRegion(layerName, regionName, def)
if regionName == 'landscape_boundary' or
regionName == 'temp_boundary' or
regionName == 'humidity_boundary' then
error(('The name `%s` is reserved for special regions and cannot be used.'):format(regionName))
end
local layer = self:getLayerByName(layerName)
local region = Region:new(regionName, def)
layer:addRegion(regionName, region)
end
-- --- INITIALIZATION METHODS ---
---Initialize the boundary region for a layer and category.
@@ -551,10 +582,14 @@ end
-- --- GENERATION METHODS ---
---@alias MapGen.nodeType 'AIR'|'WATER'|'CAVERN_AIR'|'TURF'|'SOIL'|'ROCK'|'BOTTOM'
---@alias MapGen.postProcessingData {biome:MapGen.Biome, mapGenerator:MapGen, factors:MapGen.factors, index:number, x:number, y:number, z:number, nodeType:MapGen.nodeType}
---@alias MapGen.dataPostProcessingData {biome:MapGen.Biome, mapGenerator:MapGen, factors:MapGen.factors, index:number, x:number, y:number, z:number, nodeType:MapGen.nodeType}
---@alias MapGen.vmPostProcessingData {biome:MapGen.Biome, mapGenerator:MapGen, factors:MapGen.factors, x:number, y:number, z:number, nodeType:MapGen.nodeType}
---@type table<number, MapGen.postProcessingData>
local postProcessing = {}
---@type table<number, MapGen.dataPostProcessingData>
local dataPostProcessing = {}
---@type table<number, MapGen.vmPostProcessingData>
local vmPostProcessing = {}
---@param biome MapGen.Biome
---@param mapGenerator MapGen
@@ -565,20 +600,30 @@ local postProcessing = {}
---@param z integer
---@param nodeType MapGen.nodeType
local function addPostProccessing(biome, mapGenerator, factors, index, x, y, z, nodeType)
if biome.postProcessing == nil then
return
if biome.dataPostProcessing ~= nil then
dataPostProcessing[index] = {
biome = biome,
mapGenerator = mapGenerator,
factors = factors,
index = index,
x = x,
y = y,
z = z,
nodeType = nodeType
}
end
postProcessing[index] = {
biome = biome,
mapGenerator = mapGenerator,
factors = factors,
index = index,
x = x,
y = y,
z = z,
nodeType = nodeType
}
if biome.vmPostProcessing ~= nil then
vmPostProcessing[index] = {
biome = biome,
mapGenerator = mapGenerator,
factors = factors,
x = x,
y = y,
z = z,
nodeType = nodeType
}
end
end
---The core logic of world generation. Determines which node type (water, rock, soil, air)
@@ -923,10 +968,10 @@ function MapGen:onMapGenerated(voxelManip, minPos, maxPos, blockseed)
end
end
-- Post-proccesing generation
for _, ppdata in pairs(postProcessing) do
if ppdata.biome.postProcessing ~= nil then
ppdata.biome:postProcessing(ppdata.mapGenerator,
-- Data post-proccesing generation
for _, ppdata in pairs(dataPostProcessing) do
if ppdata.biome.dataPostProcessing ~= nil then
ppdata.biome:dataPostProcessing(ppdata.mapGenerator,
ppdata.factors,
data,
data2,
@@ -939,10 +984,23 @@ function MapGen:onMapGenerated(voxelManip, minPos, maxPos, blockseed)
end
end
-- We make changes back to LVM and recalculate light & liquids
voxelManip:set_data(data)
voxelManip:set_param2_data(data2)
-- VoxelManip Post-proccesing generation
for _, ppdata in pairs(vmPostProcessing) do
if ppdata.biome.vmPostProcessing ~= nil then
ppdata.biome:vmPostProcessing(ppdata.mapGenerator,
ppdata.factors,
voxelManip,
ppdata.x,
ppdata.y,
ppdata.z,
ppdata.nodeType,
area)
end
end
core.generate_ores(voxelManip, minPos, maxPos)
core.generate_decorations(voxelManip, minPos, maxPos)

View File

@@ -3,14 +3,15 @@ local id = core.get_content_id
local getInstance = Class.getInstance
---@class MapGen.Biome
---@field name string
---@field tempPoint number
---@field humidityPoint number
---@field minY number
---@field maxY number
---@field groundNodes MapGen.Biome.GroundNodes
---@field groundNodesIDs MapGen.Biome.GroundNodesIDs
---@field soilHeight number
---@field name string
---@field tempPoint number
---@field humidityPoint number
---@field minY number
---@field maxY number
---@field groundNodes MapGen.Biome.GroundNodes
---@field groundNodesIDs MapGen.Biome.GroundNodesIDs
---@field soilHeight number
---
---@field generateAir generateFunc
---@field generateCavernAir generateFunc
---@field generateWater generateFunc
@@ -18,7 +19,9 @@ local getInstance = Class.getInstance
---@field generateTurf generateFunc
---@field generateSoil generateFunc
---@field generateBottom generateFunc
---@field postProcessing fun(self, mapGenerator:MapGen, factors:MapGen.factors, data:number[], data2:number[], index:number, x:number, y:number, z:number, nodeType:MapGen.nodeType, area:VoxelArea)?
---
---@field dataPostProcessing fun(self, mapGenerator:MapGen, factors:MapGen.factors, data:number[], data2:number[], index:number, x:number, y:number, z:number, nodeType:MapGen.nodeType, area:VoxelArea)?
---@field vmPostProcessing fun(self, mapGenerator:MapGen, factors:MapGen.factors, voxelManip:VoxelManip, x:number, y:number, z:number, nodeType:MapGen.nodeType, area:VoxelArea)?
local Biome = {}
---@alias generateFunc fun(self, mapGenerator:MapGen, factors:MapGen.factors, data:number[], data2:number[], index:number, x:number, y:number, z:number)
@@ -27,12 +30,13 @@ local Biome = {}
---
---**Only for EmmyLua.**
---@class MapGen.BiomeDef
---@field tempPoint number
---@field humidityPoint number
---@field minY number
---@field maxY number
---@field groundNodes MapGen.Biome.GroundNodes
---@field soilHeight number
---@field tempPoint number
---@field humidityPoint number
---@field minY number
---@field maxY number
---@field groundNodes MapGen.Biome.GroundNodes
---@field soilHeight number
---
---@field generateAir generateFunc?
---@field generateCavernAir generateFunc?
---@field generateWater generateFunc?
@@ -40,7 +44,9 @@ local Biome = {}
---@field generateTurf generateFunc?
---@field generateSoil generateFunc?
---@field generateBottom generateFunc?
---@field postProcessing fun(self, mapGenerator:MapGen, factors:MapGen.factors, data:number[], data2:number[], index:number, x:number, y:number, z:number, nodeType:MapGen.nodeType, area:VoxelArea)?
---
---@field dataPostProcessing fun(self, mapGenerator:MapGen, factors:MapGen.factors, data:number[], data2:number[], index:number, x:number, y:number, z:number, nodeType:MapGen.nodeType, area:VoxelArea)?
---@field vmPostProcessing fun(self, mapGenerator:MapGen, factors:MapGen.factors, voxelManip:VoxelManip, x:number, y:number, z:number, nodeType:MapGen.nodeType, area:VoxelArea)?
-- Default generate functions
@@ -183,14 +189,15 @@ function Biome:new(name, def)
---@type MapGen.Biome
local instance = getInstance(self, {})
instance.name = name
instance.tempPoint = def.tempPoint
instance.humidityPoint = def.humidityPoint
instance.minY = def.minY
instance.maxY = def.maxY
instance.groundNodes = def.groundNodes
instance.groundNodesIDs = groundNodesIDs
instance.soilHeight = def.soilHeight
instance.name = name
instance.tempPoint = def.tempPoint
instance.humidityPoint = def.humidityPoint
instance.minY = def.minY
instance.maxY = def.maxY
instance.groundNodes = def.groundNodes
instance.groundNodesIDs = groundNodesIDs
instance.soilHeight = def.soilHeight
instance.generateAir = def.generateAir
instance.generateCavernAir = def.generateCavernAir
instance.generateWater = def.generateWater
@@ -198,7 +205,9 @@ function Biome:new(name, def)
instance.generateSoil = def.generateSoil
instance.generateTurf = def.generateTurf
instance.generateBottom = def.generateBottom
instance.postProcessing = def.postProcessing
instance.dataPostProcessing = def.dataPostProcessing
instance.vmPostProcessing = def.vmPostProcessing
return instance
end

View File

@@ -0,0 +1,67 @@
local Node
if not Smc.isAsync then
Node = Smc.requireNode()
end
local getInstance = Class.getInstance
---@class MapGen.Tree
---@field name string
---@field path string
local Tree = {}
---Definition table for the `MapGen.Tree`.
---
---**Only for EmmyLua.**
---@class MapGen.TreeDef
---@field path string
---@param name string
---@param def MapGen.TreeDef
---@return MapGen.Tree
function Tree:new(name, def)
local intance = getInstance(self, {})
intance.name = name
intance.path = def.path
intance:registerPlacer()
return intance
end
function Tree:registerPlacer()
if Node == nil then
return
end
local node = Node:new({
settings = {
name = self.name..'_placer'
}
})
core.log(node.itemDef.settings.name)
core.register_lbm({
run_at_every_load = true,
name = ':'..self.name..'_placer_lbm',
nodenames = {node.itemDef.settings.name},
action = function(pos, node, dtime)
self:place(pos)
end
})
end
---@param pos MapPosition
function Tree:place(pos)
core.place_schematic(pos, self.path, 'random')
end
---@param voxelManip VoxelManip
---@param pos MapPosition
function Tree:placeOnVM(voxelManip, pos)
core.place_schematic_on_vmanip(voxelManip, pos, self.path, 'random', nil, nil, 'place_center_x, place_center_z')
end
return Tree