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

1.5 KiB

global MapGen.Cavern


methods


Cavern.getNoise


function Cavern.getNoise()-> ValueNoise

Cavern.initNoise


function Cavern.initNoise()-> nil

Cavern.getGroups


function Cavern.getGroups()
-> table<string,number>

Cavern.new


function Cavern.new(
  name: string,
  def: MapGen.CavernDef {
    minY = number,
    maxY = number,
    noiseParams = NoiseParams,
    smoothDistance = number,
    threshold = number?,
    groups = table<string,number>?,
}
) ->  MapGen.Cavern {
    name = string,
    minY = number,
    maxY = number,
    smoothDistance = number,
    threshold = number,
    getNoise = function,
    initNoise = function,
    getGroups = function,
    new = function,
    isCavern = function,
}

Cavern.isCavern


function Cavern.isCavern(
  x: integer,
  y: integer,
  z: integer
) ->  boolean

Returns true if there is a cavern at the specified coordinates.

fields


Cavern.name


Cavern.name : string

Cavern.minY


Cavern.minY : number

Cavern.maxY


Cavern.maxY : number

Cavern.smoothDistance


Cavern.smoothDistance : number

Cavern.threshold


Cavern.threshold : number