Class: Chunk<SectionMeshing>
Defined in: packages/minerender/src/world/Chunk.ts:36
A 16×16×16 block section and its render objects. Constructor coordinates identify the section. Block accessors use world block coordinates unless their name explicitly refers to positions within the chunk.
Type Parameters
| Type Parameter | Default type |
|---|---|
SectionMeshing extends boolean | false |
Constructors
Constructor
new Chunk<SectionMeshing>(
scene,
x,
y,
z,
onBlocksChanged?,
sectionModels?,
neighborCell?,
biomeAt?,
onBiomesChanged?,
lightAt?,
onLightCleared?,
ambientLight?,
biomeBlend?
): Chunk<SectionMeshing>;Defined in: packages/minerender/src/world/Chunk.ts:60
Parameters
| Parameter | Type | Default value |
|---|---|---|
scene | MineRenderScene | undefined |
x | number | undefined |
y | number | undefined |
z | number | undefined |
onBlocksChanged? | (positions, deferCulling?) => Promise<void> | undefined |
sectionModels? | SectionModels | undefined |
neighborCell? | (x, y, z) => number | undefined |
biomeAt? | (x, y, z) => Maybe<string> | undefined |
onBiomesChanged? | (biomes?) => Promise<void> | undefined |
lightAt? | (x, y, z) => number | undefined |
onLightCleared? | () => Promise<void> | undefined |
ambientLight? | number | 0 |
biomeBlend? | () => BiomeBlend | undefined | undefined |
Returns
Chunk<SectionMeshing>
Properties
| Property | Modifier | Type | Defined in |
|---|---|---|---|
scene | readonly | MineRenderScene | packages/minerender/src/world/Chunk.ts:38 |
x | readonly | number | packages/minerender/src/world/Chunk.ts:40 |
y | readonly | number | packages/minerender/src/world/Chunk.ts:41 |
z | readonly | number | packages/minerender/src/world/Chunk.ts:42 |
Methods
chunkPosToWorldPos()
chunkPosToWorldPos(pos): Vector3;Defined in: packages/minerender/src/world/Chunk.ts:868
Parameters
| Parameter | Type |
|---|---|
pos | Vector3 |
Returns
Vector3
clear()
clear(notify?): Promise<void>;Defined in: packages/minerender/src/world/Chunk.ts:818
Removes stored blocks and render objects. Set notify to false to skip the owning world's update.
Parameters
| Parameter | Type | Default value |
|---|---|---|
notify | boolean | true |
Returns
Promise<void>
dispose()
dispose(): Promise<void>;Defined in: packages/minerender/src/world/Chunk.ts:844
Returns
Promise<void>
fluidByteIndex()
fluidByteIndex(index): number;Defined in: packages/minerender/src/world/Chunk.ts:667
Fluid kind bits and level of a cell, or 0. Hidden cells report 0.
Parameters
| Parameter | Type |
|---|---|
index | number |
Returns
number
getBiomeAt()
Call Signature
getBiomeAt(
x,
y,
z
): Maybe<string>;Defined in: packages/minerender/src/world/Chunk.ts:158
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/Chunk.ts:159
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/Chunk.ts:160
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/Chunk.ts:142
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/Chunk.ts:143
Parameters
| Parameter | Type |
|---|---|
pos | Vector3 |
Returns
Maybe<BlockInfo<SectionMeshing>>
Call Signature
getBlockAt(pos): Maybe<BlockInfo<SectionMeshing>>;Defined in: packages/minerender/src/world/Chunk.ts:144
Parameters
| Parameter | Type |
|---|---|
pos | TripleArray |
Returns
Maybe<BlockInfo<SectionMeshing>>
isBlockVisibleAt()
isBlockVisibleAt(pos): boolean;Defined in: packages/minerender/src/world/Chunk.ts:652
Parameters
| Parameter | Type |
|---|---|
pos | Vector3 |
Returns
boolean
isBlockVisibleIndex()
isBlockVisibleIndex(index): boolean;Defined in: packages/minerender/src/world/Chunk.ts:657
Reports whether a cell has a visible render object or section entry.
Parameters
| Parameter | Type |
|---|---|
index | number |
Returns
boolean
isFluidIndex()
isFluidIndex(index): boolean;Defined in: packages/minerender/src/world/Chunk.ts:672
Whether the cell holds a fluid, merged or per-block.
Parameters
| Parameter | Type |
|---|---|
index | number |
Returns
boolean
isOccludingAt()
isOccludingAt(pos): boolean;Defined in: packages/minerender/src/world/Chunk.ts:676
Parameters
| Parameter | Type |
|---|---|
pos | Vector3 |
Returns
boolean
isOccludingIndex()
isOccludingIndex(index): boolean;Defined in: packages/minerender/src/world/Chunk.ts:681
Reports whether a visible cell hides neighboring cube faces.
Parameters
| Parameter | Type |
|---|---|
index | number |
Returns
boolean
placeBlocks()
placeBlocks(blocks): Promise<Vector3[]>;Defined in: packages/minerender/src/world/Chunk.ts:293
Places cells in input order and returns changed world positions without refreshing neighbors.
Parameters
| Parameter | Type |
|---|---|
blocks | readonly object[] |
Returns
Promise<Vector3[]>
placeSection()
placeSection(data): Promise<void>;Defined in: packages/minerender/src/world/Chunk.ts:400
Replaces every cell from parsed section data. The caller refreshes neighbor culling.
Parameters
| Parameter | Type |
|---|---|
data | ChunkData |
Returns
Promise<void>
rebuildSectionMesh()
rebuildSectionMesh(): Promise<void>;Defined in: packages/minerender/src/world/Chunk.ts:753
Rebuilds visible section geometry and discards results superseded by another rebuild or clear.
Returns
Promise<void>
refreshAmbientOcclusion()
refreshAmbientOcclusion(enabled): void;Defined in: packages/minerender/src/world/Chunk.ts:506
Refreshes baked corner shading after edits or a world setting change. Disabled chunks keep no AO neighborhood.
Parameters
| Parameter | Type |
|---|---|
enabled | boolean |
Returns
void
refreshBiomes()
refreshBiomes(columns?, deferCulling?): Promise<void>;Defined in: packages/minerender/src/world/Chunk.ts:185
Rebuilds biome-tinted blocks while preserving hidden blocks and unrelated render objects. The owning world can defer neighbor culling until all affected chunks are refreshed.
Parameters
| Parameter | Type | Default value |
|---|---|---|
columns? | readonly object[] | undefined |
deferCulling? | boolean | false |
Returns
Promise<void>
refreshLight()
refreshLight(indices?): Promise<void>;Defined in: packages/minerender/src/world/Chunk.ts:498
Refreshes saved lighting after adjacent columns load or unload, including columns with only light data.
Parameters
| Parameter | Type |
|---|---|
indices? | Iterable<number, any, any> |
Returns
Promise<void>
setBiomes()
setBiomes(biomes?): Promise<void>;Defined in: packages/minerender/src/world/Chunk.ts:171
Copies 64 biome IDs in x + z * 4 + y * 16 order and refreshes placed blocks. Omit the array to clear biome data.
Parameters
| Parameter | Type |
|---|---|
biomes? | readonly string[] |
Returns
Promise<void>
setBlockAt()
Call Signature
setBlockAt(
x,
y,
z,
block
): Promise<Maybe<BlockInfo<SectionMeshing>>>;Defined in: packages/minerender/src/world/Chunk.ts:257
Places a block at integer world block coordinates. Pass undefined to remove it.
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/Chunk.ts:258
Places a block at integer world block coordinates. Pass undefined to remove it.
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/Chunk.ts:259
Places a block at integer world block coordinates. Pass undefined to remove it.
Parameters
| Parameter | Type |
|---|---|
pos | TripleArray |
block | Maybe<Block> |
Returns
Promise<Maybe<BlockInfo<SectionMeshing>>>
setBlockInChunkAt()
setBlockInChunkAt(
pos,
block?,
worldPos?,
onBlocksChanged?
): Promise<Maybe<BlockInfo<SectionMeshing>>>;Defined in: packages/minerender/src/world/Chunk.ts:277
Places a block at integer chunk-local coordinates from 0 to 15.
Parameters
| Parameter | Type |
|---|---|
pos | Vector3 |
block? | Block |
worldPos? | Vector3 |
onBlocksChanged? | ((positions, deferCulling?) => Promise<void>) | undefined |
Returns
Promise<Maybe<BlockInfo<SectionMeshing>>>
setBlockVisibleAt()
setBlockVisibleAt(pos, visible): Promise<void>;Defined in: packages/minerender/src/world/Chunk.ts:628
Changes visibility at world block coordinates while preserving the block's data.
Parameters
| Parameter | Type |
|---|---|
pos | Vector3 |
visible | boolean |
Returns
Promise<void>
setCullMaskAt()
setCullMaskAt(pos, mask): Promise<void>;Defined in: packages/minerender/src/world/Chunk.ts:687
Parameters
| Parameter | Type |
|---|---|
pos | Vector3 |
mask | number |
Returns
Promise<void>
setCullMaskIndex()
setCullMaskIndex(index, mask): Promise<void>;Defined in: packages/minerender/src/world/Chunk.ts:737
Updates hidden faces for a cell's section entry or individual render object.
Parameters
| Parameter | Type |
|---|---|
index | number |
mask | number |
Returns
Promise<void>
updateCullMasks()
updateCullMasks(
indices,
occludes,
culling?,
blockAt?
): [number, number][];Defined in: packages/minerender/src/world/Chunk.ts:695
Recomputes section masks and returns changed per-block masks. Omit indices to visit every cell. culling supplies neighbor face rules; blockAt supplies visible states outside this chunk.
Parameters
| Parameter | Type |
|---|---|
indices | Iterable<number, any, any> | undefined |
occludes | (x, y, z) => boolean |
culling? | { blocks: Record<string, number>; groups?: Record<string, string[]>; profiles: object[]; } |
culling.blocks? | Record<string, number> |
culling.groups? | Record<string, string[]> |
culling.profiles? | object[] |
blockAt? | (x, y, z) => Maybe<Pick<Block, "type" | "properties">> |
Returns
[number, number][]
visibleBlockIndex()
visibleBlockIndex(index): Maybe<Pick<Block, "type" | "properties">>;Defined in: packages/minerender/src/world/Chunk.ts:662
Stored state of a rendered, visible cell, or undefined.
Parameters
| Parameter | Type |
|---|---|
index | number |
Returns
Maybe<Pick<Block, "type" | "properties">>
worldPosToChunkPos()
worldPosToChunkPos(pos): Vector3;Defined in: packages/minerender/src/world/Chunk.ts:860
Parameters
| Parameter | Type |
|---|---|
pos | Vector3 |
Returns
Vector3
chunkPosToBlockIndex()
static chunkPosToBlockIndex(pos): number;Defined in: packages/minerender/src/world/Chunk.ts:853
Maps chunk-local coordinates from 0 to 15 to a storage index, with x varying fastest, then z, then y.
Parameters
| Parameter | Type |
|---|---|
pos | Vector3 |
Returns
number
isAir()
static isAir(block): boolean;Defined in: packages/minerender/src/world/Chunk.ts:848
Parameters
| Parameter | Type |
|---|---|
block | Maybe<Block> |
Returns
boolean
raycast()
static raycast<SectionMeshing>(chunks, raycaster):
| WorldBlockIntersection
| undefined;Defined in: packages/minerender/src/world/Chunk.ts:77
Finds the nearest owned block hit across sections, testing each shared mesh once.
Type Parameters
| Type Parameter |
|---|
SectionMeshing extends boolean |
Parameters
| Parameter | Type |
|---|---|
chunks | Iterable<Chunk<SectionMeshing>> |
raycaster | Raycaster |
Returns
| WorldBlockIntersection | undefined