Zones

Defined in: sdk/src/worldgen/zones.ts:66

The zones of one world.

Constructors

Constructor

new Zones(): Zones

Returns

Zones

Properties

onChange

onChange: ((bounds, zone) => void) | null = null

Defined in: sdk/src/worldgen/zones.ts:72

Told the area every change touched (the zone’s old and new bounds) and the zone there, so only what stands there is placed again.

---

revision

revision: number = 0

Defined in: sdk/src/worldgen/zones.ts:70

Bumped on every change.

Methods

all()

all(): IterableIterator<ZoneDef>

Defined in: sdk/src/worldgen/zones.ts:107

Returns

IterableIterator<ZoneDef>

---

at()

at(x, z, reach?): object[]

Defined in: sdk/src/worldgen/zones.ts:112

The zones that hold at (x, z), with how much, highest priority first.

Parameters

x

number

z

number

reach?

number = 0

Returns

object[]

---

delete()

delete(id): void

Defined in: sdk/src/worldgen/zones.ts:95

Parameters

id

string

Returns

void

---

excluding()

excluding(x, z, radius, tags, seed): ZoneDef | null

Defined in: sdk/src/worldgen/zones.ts:125

The zone that keeps out something of radius radius carrying tags at (x, z), or null. Inside a zone it is kept out; in its edge it is kept out with the zone’s weight there, by a draw fixed for that place, so the edge thins instead of ending on a line.

Parameters

x

number

z

number

radius

number

tags

readonly string[]

seed

number

Returns

ZoneDef | null

---

get()

get(id): ZoneDef | undefined

Defined in: sdk/src/worldgen/zones.ts:103

Parameters

id

string

Returns

ZoneDef | undefined

---

set()

set(zone): void

Defined in: sdk/src/worldgen/zones.ts:86

Parameters

zone

ZoneDef

Returns

void

---

subscribe()

subscribe(listener): () => void

Defined in: sdk/src/worldgen/zones.ts:75

Listens alongside other consumers; the returned function stops listening.

Parameters

listener

(bounds, zone) => void

Returns

() => void