MapGen: add annotations
This commit is contained in:
@@ -132,7 +132,7 @@ end
|
|||||||
---
|
---
|
||||||
---Note: layers must not overlap.
|
---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 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`
|
---@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.
|
-- Layers with the same name cannot exist.
|
||||||
assert(self.layersByName[name] == nil, ('A layer named `%s` is already registered.'):format(name))
|
assert(self.layersByName[name] == nil, ('A layer named `%s` is already registered.'):format(name))
|
||||||
@@ -152,10 +152,11 @@ function MapGen:registerLayer(name, def)
|
|||||||
end)
|
end)
|
||||||
end
|
end
|
||||||
|
|
||||||
---@param layerName string
|
---Register the color and the noise parameters that correspond to it.
|
||||||
---@param category MapGen.Layer.Category TODO: описание
|
---@param layerName string The name of the layer for which the color will be registered.
|
||||||
---@param color ColorString TODO: описание
|
---@param category MapGen.Layer.Category Category indicating what will be generated by noise.
|
||||||
---@param noiseParams NoiseParams
|
---@param color ColorString Noise color. Must be unique.
|
||||||
|
---@param noiseParams NoiseParams Fractal noise parameters.
|
||||||
function MapGen:registerLayerNoiseColor(layerName, category, color, noiseParams)
|
function MapGen:registerLayerNoiseColor(layerName, category, color, noiseParams)
|
||||||
---@type MapGen.Layer
|
---@type MapGen.Layer
|
||||||
local layer = self.layersByName[layerName]
|
local layer = self.layersByName[layerName]
|
||||||
@@ -168,8 +169,8 @@ end
|
|||||||
---Mark the world area between two heights as a `MapGen.StaticLayer`.
|
---Mark the world area between two heights as a `MapGen.StaticLayer`.
|
||||||
---
|
---
|
||||||
---Note: layers must not overlap.
|
---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 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`
|
---@param def MapGen.StaticLayerDef Static layer description table, see details `MapGen.StaticLayerDef`.
|
||||||
function MapGen:registerStaticLayer(name, def)
|
function MapGen:registerStaticLayer(name, def)
|
||||||
-- Static layer with the same name cannot exist.
|
-- Static layer with the same name cannot exist.
|
||||||
assert(self.staticsByName[name] == nil, ('A static layer named `%s` is already registered.'):format(name))
|
assert(self.staticsByName[name] == nil, ('A static layer named `%s` is already registered.'):format(name))
|
||||||
@@ -189,12 +190,12 @@ function MapGen:registerStaticLayer(name, def)
|
|||||||
end)
|
end)
|
||||||
end
|
end
|
||||||
|
|
||||||
---Mark a world point as `MapGen.Peak` and assign it a specific noise that will affect the generation.
|
---Mark a world point as `MapGen.Peak` and assign it a specific color that will affect the generation.
|
||||||
---
|
---
|
||||||
---Note: The peaks shouldn't overlap. This won't cause any errors, but it might ruin the generation.
|
---Note: The peaks shouldn't overlap. This won't cause any errors, but it might ruin the generation.
|
||||||
---@param layerName string The name of the layer in which the new peak will be included.
|
---@param layerName string The name of the layer in which the new peak will be included.
|
||||||
---@param category MapGen.Layer.Category TODO: описание
|
---@param category MapGen.Layer.Category Category indicating what will be generated by peak.
|
||||||
---@param def MapGen.PeakDef
|
---@param def MapGen.PeakDef Peak description table, see details `MapGen.PeakDef`.
|
||||||
function MapGen:registerPeak(layerName, category, def)
|
function MapGen:registerPeak(layerName, category, def)
|
||||||
---@type MapGen.Layer
|
---@type MapGen.Layer
|
||||||
local layer = self.layersByName[layerName]
|
local layer = self.layersByName[layerName]
|
||||||
@@ -209,13 +210,13 @@ function MapGen:registerPeak(layerName, category, def)
|
|||||||
layer:addPeak(category, peak)
|
layer:addPeak(category, peak)
|
||||||
end
|
end
|
||||||
|
|
||||||
---Mark a world point as `MapGen.Peak` and assign it a specific noise that will affect the generation.
|
---Mark a world point as `MapGen.Peak` and assign it a specific color that will affect the generation.
|
||||||
---The Y coordinate will be forced to zero, and the `is2d` group will be added to the groups field.
|
---The Y coordinate will be forced to zero, and the `is2d` group will be added to the groups field.
|
||||||
---
|
---
|
||||||
---Note: The peaks shouldn't overlap. This won't cause any errors, but it might ruin the generation.
|
---Note: The peaks shouldn't overlap. This won't cause any errors, but it might ruin the generation.
|
||||||
---@param layerName string The name of the layer in which the new peak will be included.
|
---@param layerName string The name of the layer in which the new peak will be included.
|
||||||
---@param category MapGen.Layer.Category TODO: описание
|
---@param category MapGen.Layer.Category Category indicating what will be generated by peak.
|
||||||
---@param def MapGen.PeakDef
|
---@param def MapGen.PeakDef Peak description table, see details `MapGen.PeakDef`.
|
||||||
function MapGen:register2DPeak(layerName, category, def)
|
function MapGen:register2DPeak(layerName, category, def)
|
||||||
def = table.copy_with_metatables(def)
|
def = table.copy_with_metatables(def)
|
||||||
|
|
||||||
@@ -234,22 +235,22 @@ end
|
|||||||
---The Y coordinate will be forced to zero, and the `is2d` group will be added to the groups field.
|
---The Y coordinate will be forced to zero, and the `is2d` group will be added to the groups field.
|
||||||
---
|
---
|
||||||
---Note: The peaks shouldn't overlap. This won't cause any errors, but it might ruin the generation.
|
---Note: The peaks shouldn't overlap. This won't cause any errors, but it might ruin the generation.
|
||||||
---@param layerName string The name of the layer in which the new peaks will be included.
|
---@param layerName string The name of the layer in which the new peaks will be included.
|
||||||
---@param category MapGen.Layer.Category TODO: описание
|
---@param category MapGen.Layer.Category Category indicating what will be generated by peaks.
|
||||||
---@param defs MapGen.PeakDef[]
|
---@param defs MapGen.PeakDef[] Peaks description table, see details `MapGen.PeakDef`.
|
||||||
function MapGen:register2DPeaks(layerName,category, defs)
|
function MapGen:register2DPeaks(layerName,category, defs)
|
||||||
for _, def in ipairs(defs) do
|
for _, def in ipairs(defs) do
|
||||||
self:register2DPeak(layerName, category, def)
|
self:register2DPeak(layerName, category, def)
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
---TODO: описание
|
---Extract the `MapGen.Peak` from the image and assign them all a specific color that will affect the generation.
|
||||||
---@param layerName string The name of the layer in which the new peaks will be included.
|
---@param layerName string The name of the layer in which the new peaks will be included.
|
||||||
---@param map string TODO: описание
|
---@param map string The name of the image from which the peaks will be extracted. It should be located in the `<mod_name>/textures/maps` folder and have the following format `<image_name>.ff`
|
||||||
---@param scale number TODO: описание
|
---@param scale number Multiplier of how many blocks (nodes) will be between image pixels. It is not recommended to set the value below 50 for performance reasons.
|
||||||
---@param zeroPos Position2d TODO: описание
|
---@param zeroPos Position2d The position in pixels where the zero world coordinate will be in the image.
|
||||||
---@param category MapGen.Layer.Category TODO: описание
|
---@param category MapGen.Layer.Category Category indicating what will be generated by peaks.
|
||||||
---@param groups? table<string, number>
|
---@param groups? table<string, number> Groups that will be added to all peaks.
|
||||||
function MapGen:register2DPeaksFromFile(layerName, map, scale,zeroPos, category, groups)
|
function MapGen:register2DPeaksFromFile(layerName, map, scale,zeroPos, category, groups)
|
||||||
local modPath = core.get_modpath(core.get_current_modname())
|
local modPath = core.get_modpath(core.get_current_modname())
|
||||||
local peaks = ff2luat(modPath .. '/textures/maps/' .. map)
|
local peaks = ff2luat(modPath .. '/textures/maps/' .. map)
|
||||||
@@ -315,6 +316,7 @@ function MapGen:initLayersTriangultaion()
|
|||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
|
---Initialize all layer noises. This should be called after the map object is loaded.
|
||||||
function MapGen:initLayersNoises()
|
function MapGen:initLayersNoises()
|
||||||
---@param layer MapGen.Layer
|
---@param layer MapGen.Layer
|
||||||
for _, layer in ipairs(self.layersList) do
|
for _, layer in ipairs(self.layersList) do
|
||||||
|
|||||||
@@ -107,11 +107,12 @@ function Layer:new(name, def)
|
|||||||
return instance
|
return instance
|
||||||
end
|
end
|
||||||
|
|
||||||
|
---A category of noise that affects specific map generation objects.
|
||||||
---@alias MapGen.Layer.Category 'landscape'|'temp'|'humidity'
|
---@alias MapGen.Layer.Category 'landscape'|'temp'|'humidity'
|
||||||
|
|
||||||
---Adds a peak to the `Layer.peaksList`
|
---Adds a peak to the `Layer.peaksList`
|
||||||
---@param category MapGen.Layer.Category TODO: описание
|
---@param category MapGen.Layer.Category
|
||||||
---@param peak MapGen.Peak TODO: описание
|
---@param peak MapGen.Peak
|
||||||
function Layer:addPeak(category, peak)
|
function Layer:addPeak(category, peak)
|
||||||
if category == 'landscape' then
|
if category == 'landscape' then
|
||||||
table.insert(self.peaksList.landscape, peak)
|
table.insert(self.peaksList.landscape, peak)
|
||||||
@@ -125,8 +126,8 @@ function Layer:addPeak(category, peak)
|
|||||||
end
|
end
|
||||||
|
|
||||||
---Adds a NoiseParams color to the `Layer.noisesParamsByColor`
|
---Adds a NoiseParams color to the `Layer.noisesParamsByColor`
|
||||||
---@param category MapGen.Layer.Category TODO: описание
|
---@param category MapGen.Layer.Category
|
||||||
---@param color ColorString TODO: описание
|
---@param color ColorString
|
||||||
---@param noiseParams NoiseParams
|
---@param noiseParams NoiseParams
|
||||||
function Layer:addNoiseParamsColor(category, color, noiseParams)
|
function Layer:addNoiseParamsColor(category, color, noiseParams)
|
||||||
color = core.colorspec_to_colorstring(core.colorspec_to_table(color))
|
color = core.colorspec_to_colorstring(core.colorspec_to_table(color))
|
||||||
@@ -148,8 +149,8 @@ function Layer:addNoiseParamsColor(category, color, noiseParams)
|
|||||||
end
|
end
|
||||||
|
|
||||||
---Returns noise corresponding to a color.
|
---Returns noise corresponding to a color.
|
||||||
---@param category MapGen.Layer.Category TODO: описание
|
---@param category MapGen.Layer.Category
|
||||||
---@param color ColorString TODO: описание
|
---@param color ColorString
|
||||||
---@return ValueNoise
|
---@return ValueNoise
|
||||||
function Layer:getNoiseByColor(category, color)
|
function Layer:getNoiseByColor(category, color)
|
||||||
color = core.colorspec_to_colorstring(core.colorspec_to_table(color))
|
color = core.colorspec_to_colorstring(core.colorspec_to_table(color))
|
||||||
|
|||||||
Reference in New Issue
Block a user