WorldPlan
Defined in: sdk/src/worldgen/plan.ts:110
One world’s plan.
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new WorldPlan(
rules,env,zones,seed,world):WorldPlan
Defined in: sdk/src/worldgen/plan.ts:117
Parameters
Section titled “Parameters”Environment
number
string
Returns
Section titled “Returns”WorldPlan
Properties
Section titled “Properties”
readonlyenv:Environment
Defined in: sdk/src/worldgen/plan.ts:117
readonlyrules:WorldRules
Defined in: sdk/src/worldgen/plan.ts:117
readonlyseed:number
Defined in: sdk/src/worldgen/plan.ts:117
readonlyworld:string
Defined in: sdk/src/worldgen/plan.ts:117
readonlyzones:Zones
Defined in: sdk/src/worldgen/plan.ts:117
Methods
Section titled “Methods”biomeAt()
Section titled “biomeAt()”biomeAt(
x,z):string|null
Defined in: sdk/src/worldgen/plan.ts:163
The biome that holds most at (x, z), or null.
Parameters
Section titled “Parameters”number
number
Returns
Section titled “Returns”string | null
biomeWeights()
Section titled “biomeWeights()”biomeWeights(
x,z):object[]
Defined in: sdk/src/worldgen/plan.ts:141
The weight of every biome that holds at (x, z), summing to 1 (empty where none does), heaviest first.
Parameters
Section titled “Parameters”number
number
Returns
Section titled “Returns”object[]
explain()
Section titled “explain()”explain(
x,z):object
Defined in: sdk/src/worldgen/plan.ts:221
Everything that decided what stands at (x, z): the fields, the biomes, the zones, and each layer’s candidate in that cell.
Parameters
Section titled “Parameters”number
number
Returns
Section titled “Returns”object
biomes
Section titled “biomes”biomes:
object[]
fields
Section titled “fields”fields:
FieldValues
layers
Section titled “layers”layers:
object[]
zones:
object[]
group()
Section titled “group()”Defined in: sdk/src/worldgen/plan.ts:241
The group of layer li in grid cell (gx, gz), or why there is none.
Parameters
Section titled “Parameters”number
number
number
Returns
Section titled “Returns”groupsIn()
Section titled “groupsIn()”groupsIn(
layer,x0,z0,x1,z1):Group[]
Defined in: sdk/src/worldgen/plan.ts:185
The groups of layer layer whose anchors stand in [x0, x1) by [z0, z1).
Parameters
Section titled “Parameters”string
number
number
number
number
Returns
Section titled “Returns”Group[]
invalidate()
Section titled “invalidate()”invalidate():
void
Defined in: sdk/src/worldgen/plan.ts:130
Forgets what was worked out: the ground, the water or the zones changed.
Returns
Section titled “Returns”void
layerIndex()
Section titled “layerIndex()”layerIndex(
id):number
Defined in: sdk/src/worldgen/plan.ts:136
The layer’s index by id, or -1.
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”number
paint()
Section titled “paint()”paint(
x,z,base):number[]
Defined in: sdk/src/worldgen/plan.ts:168
The ground’s paint at (x, z): base (grass, dirt, snow, rock) pulled toward each biome’s paint by its weight and strength.
Parameters
Section titled “Parameters”number
number
readonly number[]
Returns
Section titled “Returns”number[]
placementsIn()
Section titled “placementsIn()”placementsIn(
x0,z0,x1,z1,layers?):Placement[]
Defined in: sdk/src/worldgen/plan.ts:198
Every placement of the given layers (all, by default) whose group’s anchor stands in the square.
Parameters
Section titled “Parameters”number
number
number
number
layers?
Section titled “layers?”readonly string[]
Returns
Section titled “Returns”stats()
Section titled “stats()”stats(
layer,x0,z0,x1,z1):Record<"placed"|Rejection,number>
Defined in: sdk/src/worldgen/plan.ts:208
How many candidates of a layer in the square stood, and why the rest did not.
Parameters
Section titled “Parameters”string
number
number
number
number
Returns
Section titled “Returns”Record<"placed" | Rejection, number>