@pumpkin-plugins/terrain API / capture / TerrainCapture

Class: TerrainCapture

Defined in: capture.ts:70

Builds bounded column data incrementally from a host-provided terrain source.

Methods

progress()

progress(): number

Defined in: capture.ts:164

Returns the fraction of the region covered, including any collapsed spans.

Returns

number

---

result()

result(): TerrainCaptureResult

Defined in: capture.ts:170

Returns the captured material table and columns after sampling has finished.

Returns

TerrainCaptureResult

---

step()

step(source, budget): boolean

Defined in: capture.ts:113

Samples at most the requested number of blocks and reports when the region is complete.

Parameters

source

TerrainSource

budget

number

Returns

boolean