TerrainProvider
Defined in: sdk/src/terrain/provider.ts:42
A generator of ground.
Properties
Section titled “Properties”
readonlyid:string
Defined in: sdk/src/terrain/provider.ts:44
The name a Terrain asks for it by.
versions
Section titled “versions”
readonlyversions: readonlynumber[]
Defined in: sdk/src/terrain/provider.ts:46
The generator versions it can still make.
Methods
Section titled “Methods”heightAt()?
Section titled “heightAt()?”
optionalheightAt(world,seed,version,x,z):number
Defined in: sdk/src/terrain/provider.ts:52
The height at one point, for a provider that can answer one at once; without it a point is answered from sampled regions.
Parameters
Section titled “Parameters”string
number
version
Section titled “version”number
number
number
Returns
Section titled “Returns”number
range()
Section titled “range()”range(
seed,version): [number,number]
Defined in: sdk/src/terrain/provider.ts:48
The least and most height its ground can have for this seed and version: what the GPU encodes heights over.
Parameters
Section titled “Parameters”number
version
Section titled “version”number
Returns
Section titled “Returns”[number, number]
sample()
Section titled “sample()”sample(
region):TerrainSamples|Promise<TerrainSamples>
Defined in: sdk/src/terrain/provider.ts:50
The ground over a region. May answer later (a worker, a server); must answer the same for the same region every time.
Parameters
Section titled “Parameters”region
Section titled “region”Returns
Section titled “Returns”TerrainSamples | Promise<TerrainSamples>