Skip to content

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 ParameterDefault type
SectionMeshing extends booleanfalse

Constructors ​

Constructor ​

ts
new MineRenderWorld<SectionMeshing>(scene, options?): MineRenderWorld<SectionMeshing>;

Defined in: packages/minerender/src/world/MineRenderWorld.ts:55

Parameters ​

ParameterType
sceneMineRenderScene
optionsMineRenderWorldOptions<SectionMeshing>

Returns ​

MineRenderWorld<SectionMeshing>

Properties ​

PropertyModifierTypeDefined in
scenereadonlyMineRenderScenepackages/minerender/src/world/MineRenderWorld.ts:35

Accessors ​

ambientOcclusion ​

Get Signature ​

ts
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 ​

ts
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() ​

ts
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 ​

ts
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 ​
ParameterType
xnumber
ynumber
znumber
Returns ​

Maybe<string>

Call Signature ​

ts
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 ​
ParameterType
posVector3
Returns ​

Maybe<string>

Call Signature ​

ts
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 ​
ParameterType
posTripleArray
Returns ​

Maybe<string>


getBlockAt() ​

Call Signature ​

ts
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 ​
ParameterType
xnumber
ynumber
znumber
Returns ​

Maybe<BlockInfo<SectionMeshing>>

Call Signature ​

ts
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 ​
ParameterType
posVector3
Returns ​

Maybe<BlockInfo<SectionMeshing>>

Call Signature ​

ts
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 ​
ParameterType
posTripleArray
Returns ​

Maybe<BlockInfo<SectionMeshing>>


getChunkAt() ​

ts
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 ​

ParameterType
posVector3

Returns ​

Maybe<Chunk<SectionMeshing>>


getLightAt() ​

Call Signature ​

ts
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 ​
ParameterType
xnumber
ynumber
znumber
Returns ​

Maybe<SavedLightSample>

Call Signature ​

ts
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 ​
ParameterType
posVector3
Returns ​

Maybe<SavedLightSample>

Call Signature ​

ts
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 ​
ParameterType
posTripleArray
Returns ​

Maybe<SavedLightSample>


placeChunk() ​

ts
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 ​

ParameterType
chunkAnvilChunk
executor?BatchedExecutor

Returns ​

Promise<void>


placeChunks() ​

ts
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 ​

ParameterType
chunksreadonly AnvilChunk[]

Returns ​

Promise<void>


placeMultiBlock() ​

ts
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 ​

ParameterTypeDefault valueDescription
multiblockMultiBlockStructureundefined-
useBatchesbooleantrueYields between chunks by default. Set to false for sequential placement.
executor?BatchedExecutorundefinedOptional queue for batched placement. The caller remains responsible for stopping it.

Returns ​

Promise<void>


raycast() ​

ts
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 ​

ParameterType
raycasterRaycaster

Returns ​

| WorldBlockIntersection | undefined


raycastEntities() ​

ts
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 ​

ParameterType
raycasterRaycaster

Returns ​

| WorldEntityIntersection | undefined


setAmbientOcclusion() ​

ts
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 ​

ParameterType
enabledboolean

Returns ​

Promise<void>


setBiomeBlendRadius() ​

ts
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 ​

ParameterType
radiusnumber

Returns ​

Promise<void>


setBlockAt() ​

Call Signature ​

ts
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 ​
ParameterType
xnumber
ynumber
znumber
blockMaybe<Block>
Returns ​

Promise<Maybe<BlockInfo<SectionMeshing>>>

Call Signature ​

ts
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 ​
ParameterType
posVector3
blockMaybe<Block>
Returns ​

Promise<Maybe<BlockInfo<SectionMeshing>>>

Call Signature ​

ts
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 ​
ParameterType
posTripleArray
blockMaybe<Block>
Returns ​

Promise<Maybe<BlockInfo<SectionMeshing>>>


setBlockVisibleAt() ​

Call Signature ​

ts
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 ​
ParameterType
xnumber
ynumber
znumber
visibleboolean
Returns ​

Promise<void>

Call Signature ​

ts
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 ​
ParameterType
posVector3
visibleboolean
Returns ​

Promise<void>

Call Signature ​

ts
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 ​
ParameterType
posTripleArray
visibleboolean
Returns ​

Promise<void>


unloadChunkColumn() ​

ts
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 ​

ParameterType
xnumber
znumber

Returns ​

Promise<void>


unloadChunkColumns() ​

ts
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 ​

ParameterType
positionsreadonly object[]

Returns ​

Promise<void>


validatePosBounds() ​

ts
validatePosBounds(pos): void;

Defined in: packages/minerender/src/world/MineRenderWorld.ts:816

Parameters ​

ParameterType
posVector3

Returns ​

void


worldPosToChunkKey() ​

ts
worldPosToChunkKey(pos): string;

Defined in: packages/minerender/src/world/MineRenderWorld.ts:809

Parameters ​

ParameterType
posVector3

Returns ​

string


sceneToWorldPosition() ​

ts
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 ​

ParameterType
posVector3

Returns ​

Vector3


worldToScenePosition() ​

ts
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 ​

ParameterType
posVector3

Returns ​

Vector3