Files
simple-makes-complex/docs/docs/modules/MapGen.Layer.md

9.1 KiB

global MapGen.Layer


methods


Layer.calcTemp


function Layer.calcTemp(
  self: MapGen.Layer {
    name = string,
    minY = integer,
    maxY = integer,
    minTemp = integer,
    maxTemp = integer,
    minHumidity = integer,
    maxHumidity = integer,
    waterLevel = integer,
    peaksList = { humidity: MapGen.Peak[], landscape: MapGen.Peak[], temp: MapGen.Peak[] },
    noisesByColor = { humidity: table<ColorString,ValueNoise>, landscape: table<ColorString,ValueNoise>, temp: table<ColorString,ValueNoise> },
    noisesParamsByColor = { humidity: table<ColorString,NoiseParams>, landscape: table<ColorString,NoiseParams>, temp: table<ColorString,NoiseParams> },
    biomesByName = table<string,MapGen.Biome>,
    biomesList = MapGen.Biome[],
    biomesDiagram = table,
    biomesGorizontalScattering = integer,
    biomesVerticalScattering = integer,
    cavernsByName = table<string,MapGen.Cavern>,
    cavernsList = MapGen.Cavern[],
    trianglesList = { humidity: MapGen.Triangle[], landscape: MapGen.Triangle[], temp: MapGen.Triangle[] },
    tetrahedronsList = MapGen.Tetrahedron[],
    calcTemp = function,
    calcHumidity = function,
    new = function,
    addPeak = function,
    addNoiseParamsColor = function,
    getNoiseByColor = function,
    addBiome = function,
    addCavern = function,
    initNoises = function,
    initBiomesDiagram = function,
},
  value: number,
  height: number
)-> number

Layer.calcHumidity


function Layer.calcHumidity(
  self: MapGen.Layer {
    name = string,
    minY = integer,
    maxY = integer,
    minTemp = integer,
    maxTemp = integer,
    minHumidity = integer,
    maxHumidity = integer,
    waterLevel = integer,
    peaksList = { humidity: MapGen.Peak[], landscape: MapGen.Peak[], temp: MapGen.Peak[] },
    noisesByColor = { humidity: table<ColorString,ValueNoise>, landscape: table<ColorString,ValueNoise>, temp: table<ColorString,ValueNoise> },
    noisesParamsByColor = { humidity: table<ColorString,NoiseParams>, landscape: table<ColorString,NoiseParams>, temp: table<ColorString,NoiseParams> },
    biomesByName = table<string,MapGen.Biome>,
    biomesList = MapGen.Biome[],
    biomesDiagram = table,
    biomesGorizontalScattering = integer,
    biomesVerticalScattering = integer,
    cavernsByName = table<string,MapGen.Cavern>,
    cavernsList = MapGen.Cavern[],
    trianglesList = { humidity: MapGen.Triangle[], landscape: MapGen.Triangle[], temp: MapGen.Triangle[] },
    tetrahedronsList = MapGen.Tetrahedron[],
    calcTemp = function,
    calcHumidity = function,
    new = function,
    addPeak = function,
    addNoiseParamsColor = function,
    getNoiseByColor = function,
    addBiome = function,
    addCavern = function,
    initNoises = function,
    initBiomesDiagram = function,
},
  value: number,
  height: number
)-> number

Layer.new


function Layer.new(
  name: string,
  def: MapGen.LayerDef {
    minY = number,
    maxY = number,
    minTemp = number,
    maxTemp = number,
    minHumidity = number,
    maxHumidity = number,
    waterLevel = number?,
    calcTemp = (fun(self: MapGen.Layer, value: number, height: number) -> number)?,
    calcHumidity = (fun(self: MapGen.Layer, value: number, height: number) -> number)?,
    biomesGorizontalScattering = number?,
    biomesVerticalScattering = number?,
}
) ->  MapGen.Layer {
    name = string,
    minY = integer,
    maxY = integer,
    minTemp = integer,
    maxTemp = integer,
    minHumidity = integer,
    maxHumidity = integer,
    waterLevel = integer,
    peaksList = { humidity: MapGen.Peak[], landscape: MapGen.Peak[], temp: MapGen.Peak[] },
    noisesByColor = { humidity: table<ColorString,ValueNoise>, landscape: table<ColorString,ValueNoise>, temp: table<ColorString,ValueNoise> },
    noisesParamsByColor = { humidity: table<ColorString,NoiseParams>, landscape: table<ColorString,NoiseParams>, temp: table<ColorString,NoiseParams> },
    biomesByName = table<string,MapGen.Biome>,
    biomesList = MapGen.Biome[],
    biomesDiagram = table,
    biomesGorizontalScattering = integer,
    biomesVerticalScattering = integer,
    cavernsByName = table<string,MapGen.Cavern>,
    cavernsList = MapGen.Cavern[],
    trianglesList = { humidity: MapGen.Triangle[], landscape: MapGen.Triangle[], temp: MapGen.Triangle[] },
    tetrahedronsList = MapGen.Tetrahedron[],
    calcTemp = function,
    calcHumidity = function,
    new = function,
    addPeak = function,
    addNoiseParamsColor = function,
    getNoiseByColor = function,
    addBiome = function,
    addCavern = function,
    initNoises = function,
    initBiomesDiagram = function,
}

Layer.addPeak


function Layer.addPeak(
  category: MapGen.Layer.Category,
  peak: MapGen.Peak {
    id = number,
    getPeakPos = function,
    getColor = function,
    getGroups = function,
    new = function,
    toString = function,
    eq = function,
}
) ->  nil

Adds a peak to the Layer.peaksList

Layer.addNoiseParamsColor


function Layer.addNoiseParamsColor(
  category: MapGen.Layer.Category,
  color: ColorString,
  noiseParams: NoiseParams
) ->  nil

Adds a NoiseParams color to the Layer.noisesParamsByColor

Layer.getNoiseByColor


function Layer.getNoiseByColor(
  category: MapGen.Layer.Category,
  color: ColorString
) ->  ValueNoise

Returns noise corresponding to a color.

Layer.addBiome


function Layer.addBiome(
  biomeName: string,
  biome: MapGen.Biome {
    name = string,
    tempPoint = number,
    humidityPoint = number,
    minY = number,
    maxY = number,
    groundNodes = MapGen.Biome.GroundNodes,
    groundNodesIDs = MapGen.Biome.GroundNodesIDs,
    soilHeight = number,
    generateAir = generateFunc,
    generateCavernAir = generateFunc,
    generateWater = generateFunc,
    generateRock = generateFunc,
    generateTurf = generateFunc,
    generateSoil = generateFunc,
    generateBottom = generateFunc,
    new = function,
}
) ->  nil

Adds a biome to the Layer.biomesByName & Layer.biomesList

Layer.addCavern


function Layer.addCavern(
  cavernName: string,
  cavern: MapGen.Cavern {
    name = string,
    minY = number,
    maxY = number,
    smoothDistance = number,
    threshold = number,
    getNoise = function,
    initNoise = function,
    getGroups = function,
    new = function,
    isCavern = function,
}
) ->  nil

Adds a cavern to the Layer.cavernsByName & Layer.cavernsList

Layer.initNoises


function Layer.initNoises() ->  nil

Initializes noise for generation.

Should only be called after the mapgen object has been loaded.

Layer.initBiomesDiagram


function Layer.initBiomesDiagram() ->  nil

Initialization of the biome diagram using the Voronoi method.

fields


Layer.name


Layer.name : string

Layer.minY


Layer.minY : integer

Layer.maxY


Layer.maxY : integer

Layer.minTemp


Layer.minTemp : integer

Layer.maxTemp


Layer.maxTemp : integer

Layer.minHumidity


Layer.minHumidity : integer

Layer.maxHumidity


Layer.maxHumidity : integer

Layer.waterLevel


Layer.waterLevel : integer

Layer.peaksList


Layer.peaksList : { humidity: MapGen.Peak[], landscape: MapGen.Peak[], temp: MapGen.Peak[] }

Layer.noisesByColor


Layer.noisesByColor : { humidity: table<ColorString,ValueNoise>, landscape: table<ColorString,ValueNoise>, temp: table<ColorString,ValueNoise> }

Layer.noisesParamsByColor


Layer.noisesParamsByColor : { humidity: table<ColorString,NoiseParams>, landscape: table<ColorString,NoiseParams>, temp: table<ColorString,NoiseParams> }

Layer.biomesByName


Layer.biomesByName : table<string,MapGen.Biome>

Layer.biomesList


Layer.biomesList : MapGen.Biome[]

Layer.biomesDiagram


Layer.biomesDiagram : table

Layer.biomesGorizontalScattering


Layer.biomesGorizontalScattering : integer

Layer.biomesVerticalScattering


Layer.biomesVerticalScattering : integer

Layer.cavernsByName


Layer.cavernsByName : table<string,MapGen.Cavern>

Layer.cavernsList


Layer.cavernsList : MapGen.Cavern[]

Layer.trianglesList


Layer.trianglesList : { humidity: MapGen.Triangle[], landscape: MapGen.Triangle[], temp: MapGen.Triangle[] }

Layer.tetrahedronsList


Layer.tetrahedronsList : MapGen.Tetrahedron[]

Not supported