Struct GenerationChunk 

#[repr(transparent)]
pub struct GenerationChunk<'a, Phase> {
    chunk: &'a Chunk,
    phase: PhantomData<fn() -> Phase>,
}

Stage-scoped access to the center chunk being generated.

The scheduler constructs this capability only after the chunk’s input status is published. It deliberately does not expose the underlying Chunk or its raw section storage, so status-sensitive writes stay tied to the operation that owns them.

use steel_core::worldgen::generator::{GenerationChunk, NoisePhase};

fn write_surface_column_during_noise(chunk: GenerationChunk<'_, NoisePhase>) {
    chunk.write_column(0, 0, &[]);
}

Fields

chunk: &'a Chunk

phase: PhantomData<fn() -> Phase>

Implementations

impl<'a, Phase> GenerationChunk<'a, Phase>

const fn from_chunk(chunk: &'a Chunk) -> Self

fn acquire_input(holder: &'a ChunkHolder, input_status: ChunkStatus) -> Self

pub const fn pos(self) -> ChunkPos

Returns the chunk position.

pub const fn min_y(self) -> i32

Returns the dimension’s minimum block Y.

pub const fn height(self) -> i32

Returns the dimension’s build height.

pub fn section_count(self) -> usize

Returns the number of vertical chunk sections.

pub fn get_relative_block( self, relative_x: usize, relative_y: usize, relative_z: usize, ) -> Option<BlockStateId>

Reads one block using coordinates relative to the dimension’s minimum Y.

pub fn get_block_state(self, pos: BlockPos) -> BlockStateId

Reads one block at a world position.

impl GenerationChunk<'_, NoisePhase>

pub(crate) fn acquire(holder: &ChunkHolder) -> GenerationChunk<'_, NoisePhase>

pub fn write_block_batch(self, blocks: &[(usize, usize, usize, BlockStateId)])

Writes a Noise-stage block batch using the published Biomes semantics.

pub fn replace_noise_heightmaps( self, ocean_floor: Heightmap, world_surface: Heightmap, )

Replaces the two heightmaps initialized directly by terrain noise filling.

Panics

Panics if either heightmap has a type other than its corresponding noise-stage type.

pub fn install_post_noise_state<T>(self, state: T)

where T: DowncastType + Send + Sync,

Installs generator-owned state for reuse by Surface and Carvers.

pub fn mark_pos_for_postprocessing(self, pos: BlockPos)

Marks a position for Vanilla generation postprocessing.

pub fn set_relative_block( self, relative_x: usize, relative_y: usize, relative_z: usize, state: BlockStateId, )

Writes one block using the published Biomes semantics.

impl GenerationChunk<'_, SurfacePhase>

pub(crate) fn acquire(holder: &ChunkHolder) -> GenerationChunk<'_, SurfacePhase>

pub fn prime_world_surface_heightmap(self)

Ensures the world-surface worldgen heightmap exists.

pub fn with_post_noise_state_mut<T, R>( self, f: impl FnOnce(&mut T) -> R, ) -> Option<R>

where T: DowncastType + Send + Sync,

Borrows generator-owned state retained after Noise.

pub fn read_all_biomes(self) -> Box<[u16]>

Copies every biome palette entry in section order.

pub fn read_column_into( self, local_x: usize, local_z: usize, output: &mut Vec<BlockStateId>, )

Reads one complete block column into output.

pub fn world_surface_height_at(self, local_x: usize, local_z: usize) -> i32

Reads the world-surface worldgen height, lazily priming it if needed.

pub fn write_column( self, local_x: usize, local_z: usize, blocks: &[(usize, BlockStateId)], )

Writes one Surface-stage column and applies its Noise-input heightmap effects.

pub fn set_relative_block( self, relative_x: usize, relative_y: usize, relative_z: usize, state: BlockStateId, )

Writes one block using the published Noise semantics.

impl GenerationChunk<'_, CarversPhase>

pub(crate) fn acquire(holder: &ChunkHolder) -> GenerationChunk<'_, CarversPhase>

pub fn prime_world_surface_heightmap(self)

Ensures the world-surface worldgen heightmap exists.

pub fn clear_post_noise_state(self)

Drops retained generator state without running Carvers.

pub fn consume_post_noise_state<T, R>( self, f: impl FnOnce(Option<&mut T>) -> R, ) -> R

where T: DowncastType + Send + Sync,

Consumes generator-owned state retained after Noise.

pub fn with_carving_mask<R>(self, f: impl FnOnce(&mut CarvingMask) -> R) -> R

Runs f with the chunk’s lazily initialized carving mask.

pub fn set_block_state(self, pos: BlockPos, state: BlockStateId)

Sets one carved block using the published Surface semantics.

pub fn with_world_surface_heightmap<R>( self, f: impl FnOnce(&Heightmap) -> R, ) -> Option<R>

Runs f with the world-surface worldgen heightmap if priming provides it.

pub fn mark_pos_for_postprocessing(self, pos: BlockPos)

Marks a position for Vanilla generation postprocessing.

Trait Implementations

impl<Phase> Clone for GenerationChunk<'_, Phase>

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<Phase> Copy for GenerationChunk<'_, Phase>