Class: MineRenderWorld<SectionMeshing>
Defined in: packages/minerender/src/world/MineRenderWorld.ts:33
Stores and renders blocks in sparse 16×16×16 chunks. Positions use integer block coordinates, including negatives. One block is 16 scene units. Set options.sectionMeshing in new MineRenderWorld(scene, options) to merge compatible terrain.
Type Parameters
| Type Parameter | Default type |
|---|---|
SectionMeshing extends boolean | false |
Constructors
Constructor
new MineRenderWorld<SectionMeshing>(scene, options?): MineRenderWorld<SectionMeshing>;Defined in: packages/minerender/src/world/MineRenderWorld.ts:55
Parameters
| Parameter | Type |
|---|---|
scene | MineRenderScene |
options | MineRenderWorldOptions<SectionMeshing> |
Returns
MineRenderWorld<SectionMeshing>
Properties
| Property | Modifier | Type | Defined in |
|---|---|---|---|
scene | readonly | MineRenderScene | packages/minerender/src/world/MineRenderWorld.ts:35 |
Accessors
ambientOcclusion
Get Signature
get ambientOcclusion(): boolean;Defined in: packages/minerender/src/world/MineRenderWorld.ts:91
Whether neighboring opaque cubes shade block-face corners. Defaults to false.
Returns
boolean
biomeBlendRadius
Get Signature
get biomeBlendRadius(): number;Defined in: packages/minerender/src/world/MineRenderWorld.ts:111
Horizontal biome-color sampling radius, from 0 to 7 blocks. Zero disables blending.
Returns
number
Methods
clear()
clear(): Promise<void>;Defined in: packages/minerender/src/world/MineRenderWorld.ts:608
Removes all chunks and releases their blocks, section meshes, and owned entities.
Returns
Promise<void>
getBiomeAt()
Call Signature
getBiomeAt(
x,
y,
z
): Maybe<string>;Defined in: packages/minerender/src/world/MineRenderWorld.ts:197
Returns the saved 4-block biome sample at integer world block coordinates, or undefined if absent.
Parameters
| Parameter | Type |
|---|---|
x | number |
y | number |
z | number |
Returns
Maybe<string>
Call Signature
getBiomeAt(pos): Maybe<string>;Defined in: packages/minerender/src/world/MineRenderWorld.ts:198
Returns the saved 4-block biome sample at integer world block coordinates, or undefined if absent.
Parameters
| Parameter | Type |
|---|---|
pos | Vector3 |
Returns
Maybe<string>
Call Signature
getBiomeAt(pos): Maybe<string>;Defined in: packages/minerender/src/world/MineRenderWorld.ts:199
Returns the saved 4-block biome sample at integer world block coordinates, or undefined if absent.
Parameters
| Parameter | Type |
|---|---|
pos | TripleArray |
Returns
Maybe<string>
getBlockAt()
Call Signature
getBlockAt(
x,
y,
z
): Maybe<BlockInfo<SectionMeshing>>;Defined in: packages/minerender/src/world/MineRenderWorld.ts:182
Returns a placed block at world block coordinates, or undefined for an empty position.
Parameters
| Parameter | Type |
|---|---|
x | number |
y | number |
z | number |
Returns
Maybe<BlockInfo<SectionMeshing>>
Call Signature
getBlockAt(pos): Maybe<BlockInfo<SectionMeshing>>;Defined in: packages/minerender/src/world/MineRenderWorld.ts:183
Returns a placed block at world block coordinates, or undefined for an empty position.
Parameters
| Parameter | Type |
|---|---|
pos | Vector3 |
Returns
Maybe<BlockInfo<SectionMeshing>>
Call Signature
getBlockAt(pos): Maybe<BlockInfo<SectionMeshing>>;Defined in: packages/minerender/src/world/MineRenderWorld.ts:184
Returns a placed block at world block coordinates, or undefined for an empty position.
Parameters
| Parameter | Type |
|---|---|
pos | TripleArray |
Returns
Maybe<BlockInfo<SectionMeshing>>
getChunkAt()
getChunkAt(pos): Maybe<Chunk<SectionMeshing>>;Defined in: packages/minerender/src/world/MineRenderWorld.ts:786
Returns the loaded chunk containing a world block position, without creating a chunk.
Parameters
| Parameter | Type |
|---|---|
pos | Vector3 |
Returns
getLightAt()
Call Signature
getLightAt(
x,
y,
z
): Maybe<SavedLightSample>;Defined in: packages/minerender/src/world/MineRenderWorld.ts:214
Returns saved light at integer world block coordinates, including data marked invalid by the save. Sky light is 15 above a column's highest saved sky-light array.
Parameters
| Parameter | Type |
|---|---|
x | number |
y | number |
z | number |
Returns
Call Signature
getLightAt(pos): Maybe<SavedLightSample>;Defined in: packages/minerender/src/world/MineRenderWorld.ts:215
Returns saved light at integer world block coordinates, including data marked invalid by the save. Sky light is 15 above a column's highest saved sky-light array.
Parameters
| Parameter | Type |
|---|---|
pos | Vector3 |
Returns
Call Signature
getLightAt(pos): Maybe<SavedLightSample>;Defined in: packages/minerender/src/world/MineRenderWorld.ts:216
Returns saved light at integer world block coordinates, including data marked invalid by the save. Sky light is 15 above a column's highest saved sky-light array.
Parameters
| Parameter | Type |
|---|---|
pos | TripleArray |
Returns
placeChunk()
placeChunk(chunk, executor?): Promise<void>;Defined in: packages/minerender/src/world/MineRenderWorld.ts:379
Replaces a chunk column's blocks, biomes, and saved light and, with renderEntities, its supported saved mobs.
Parameters
| Parameter | Type |
|---|---|
chunk | AnvilChunk |
executor? | BatchedExecutor |
Returns
Promise<void>
placeChunks()
placeChunks(chunks): Promise<void>;Defined in: packages/minerender/src/world/MineRenderWorld.ts:387
Replaces parsed columns in input order, then refreshes neighboring geometry once. Duplicate coordinates retain their order. A failed column stops placement; queued refreshes finish before rejection.
Parameters
| Parameter | Type |
|---|---|
chunks | readonly AnvilChunk[] |
Returns
Promise<void>
placeMultiBlock()
placeMultiBlock(
multiblock,
useBatches?,
executor?
): Promise<void>;Defined in: packages/minerender/src/world/MineRenderWorld.ts:287
Places a structure's blocks at their stored positions, then refreshes neighboring faces. With renderEntities, also places supported saved mobs and applies supported appearance fields.
Parameters
| Parameter | Type | Default value | Description |
|---|---|---|---|
multiblock | MultiBlockStructure | undefined | - |
useBatches | boolean | true | Yields between chunks by default. Set to false for sequential placement. |
executor? | BatchedExecutor | undefined | Optional queue for batched placement. The caller remains responsible for stopping it. |
Returns
Promise<void>
raycast()
raycast(raycaster):
| WorldBlockIntersection
| undefined;Defined in: packages/minerender/src/world/MineRenderWorld.ts:77
Returns the nearest visible block geometry hit, respecting the raycaster's layers and near/far range. Includes fluids and block entities; texture alpha does not change triangle intersections.
Parameters
| Parameter | Type |
|---|---|
raycaster | Raycaster |
Returns
| WorldBlockIntersection | undefined
raycastEntities()
raycastEntities(raycaster):
| WorldEntityIntersection
| undefined;Defined in: packages/minerender/src/world/MineRenderWorld.ts:86
Returns the nearest visible mob geometry hit when renderEntities is enabled. Respects layers and near/far; compare its distance with raycast() to account for blocks. Texture alpha does not change triangle intersections.
Parameters
| Parameter | Type |
|---|---|
raycaster | Raycaster |
Returns
| WorldEntityIntersection | undefined
setAmbientOcclusion()
setAmbientOcclusion(enabled): Promise<void>;Defined in: packages/minerender/src/world/MineRenderWorld.ts:96
Rebuilds loaded blocks with or without corner shading. Block data and saved lighting are preserved.
Parameters
| Parameter | Type |
|---|---|
enabled | boolean |
Returns
Promise<void>
setBiomeBlendRadius()
setBiomeBlendRadius(radius): Promise<void>;Defined in: packages/minerender/src/world/MineRenderWorld.ts:116
Refreshes loaded grass, foliage, and water colors without reloading their source chunks.
Parameters
| Parameter | Type |
|---|---|
radius | number |
Returns
Promise<void>
setBlockAt()
Call Signature
setBlockAt(
x,
y,
z,
block
): Promise<Maybe<BlockInfo<SectionMeshing>>>;Defined in: packages/minerender/src/world/MineRenderWorld.ts:241
Places or replaces a block and refreshes neighboring faces. Pass undefined or an air block to remove the block at these world block coordinates.
Parameters
| Parameter | Type |
|---|---|
x | number |
y | number |
z | number |
block | Maybe<Block> |
Returns
Promise<Maybe<BlockInfo<SectionMeshing>>>
Call Signature
setBlockAt(pos, block): Promise<Maybe<BlockInfo<SectionMeshing>>>;Defined in: packages/minerender/src/world/MineRenderWorld.ts:242
Places or replaces a block and refreshes neighboring faces. Pass undefined or an air block to remove the block at these world block coordinates.
Parameters
| Parameter | Type |
|---|---|
pos | Vector3 |
block | Maybe<Block> |
Returns
Promise<Maybe<BlockInfo<SectionMeshing>>>
Call Signature
setBlockAt(pos, block): Promise<Maybe<BlockInfo<SectionMeshing>>>;Defined in: packages/minerender/src/world/MineRenderWorld.ts:243
Places or replaces a block and refreshes neighboring faces. Pass undefined or an air block to remove the block at these world block coordinates.
Parameters
| Parameter | Type |
|---|---|
pos | TripleArray |
block | Maybe<Block> |
Returns
Promise<Maybe<BlockInfo<SectionMeshing>>>
setBlockVisibleAt()
Call Signature
setBlockVisibleAt(
x,
y,
z,
visible
): Promise<void>;Defined in: packages/minerender/src/world/MineRenderWorld.ts:264
Shows or hides a placed block without changing its data. Hidden blocks do not occlude neighbors. Missing blocks are ignored; replacing or removing a block resets its visibility.
Parameters
| Parameter | Type |
|---|---|
x | number |
y | number |
z | number |
visible | boolean |
Returns
Promise<void>
Call Signature
setBlockVisibleAt(pos, visible): Promise<void>;Defined in: packages/minerender/src/world/MineRenderWorld.ts:265
Shows or hides a placed block without changing its data. Hidden blocks do not occlude neighbors. Missing blocks are ignored; replacing or removing a block resets its visibility.
Parameters
| Parameter | Type |
|---|---|
pos | Vector3 |
visible | boolean |
Returns
Promise<void>
Call Signature
setBlockVisibleAt(pos, visible): Promise<void>;Defined in: packages/minerender/src/world/MineRenderWorld.ts:266
Shows or hides a placed block without changing its data. Hidden blocks do not occlude neighbors. Missing blocks are ignored; replacing or removing a block resets its visibility.
Parameters
| Parameter | Type |
|---|---|
pos | TripleArray |
visible | boolean |
Returns
Promise<void>
unloadChunkColumn()
unloadChunkColumn(x, z): Promise<void>;Defined in: packages/minerender/src/world/MineRenderWorld.ts:528
Removes blocks and owned entities at chunk-column coordinates, then refreshes neighboring faces and fluids. Coordinates match AnvilChunk.x/z, not block positions. Missing columns are ignored.
Parameters
| Parameter | Type |
|---|---|
x | number |
z | number |
Returns
Promise<void>
unloadChunkColumns()
unloadChunkColumns(positions): Promise<void>;Defined in: packages/minerender/src/world/MineRenderWorld.ts:536
Removes chunk columns together and refreshes surviving neighbors once. Coordinates are absolute chunk columns. Duplicate and missing columns are ignored.
Parameters
| Parameter | Type |
|---|---|
positions | readonly object[] |
Returns
Promise<void>
validatePosBounds()
validatePosBounds(pos): void;Defined in: packages/minerender/src/world/MineRenderWorld.ts:816
Parameters
| Parameter | Type |
|---|---|
pos | Vector3 |
Returns
void
worldPosToChunkKey()
worldPosToChunkKey(pos): string;Defined in: packages/minerender/src/world/MineRenderWorld.ts:809
Parameters
| Parameter | Type |
|---|---|
pos | Vector3 |
Returns
string
sceneToWorldPosition()
static sceneToWorldPosition(pos): Vector3;Defined in: packages/minerender/src/world/MineRenderWorld.ts:801
Converts scene units to block coordinates without rounding to an integer block.
Parameters
| Parameter | Type |
|---|---|
pos | Vector3 |
Returns
Vector3
worldToScenePosition()
static worldToScenePosition(pos): Vector3;Defined in: packages/minerender/src/world/MineRenderWorld.ts:792
Converts block coordinates to scene units by multiplying each component by 16.
Parameters
| Parameter | Type |
|---|---|
pos | Vector3 |
Returns
Vector3