Struct WorldGenRegion 

pub struct WorldGenRegion<'a> {
    context: &'a WorldGenContext,
    step: &'a ChunkStep,
    cache: &'a StaticCache2D<Arc<ChunkHolder>>,
    center: ChunkPos,
    chunk_cache_radius: i32,
    chunks: RefCell<Box<[Option<CachedWorldGenChunk<'a>>]>>,
    worldgen_heightmaps: RefCell<Box<[CachedWorldgenHeightmaps]>>,
    random: RandomSource,
}

Chunk-cache backed worldgen view for the current generation step.

This deliberately differs from vanilla’s WorldGenRegion in one area: it only exposes chunks already collected by Steel’s StaticCache2D and validated against ChunkStep. That keeps generation deterministic and makes missing dependency declarations fail at the region boundary instead of silently reading farther chunks.

Fields

context: &'a WorldGenContext

step: &'a ChunkStep

cache: &'a StaticCache2D<Arc<ChunkHolder>>

center: ChunkPos

chunk_cache_radius: i32

chunks: RefCell<Box<[Option<CachedWorldGenChunk<'a>>]>>

worldgen_heightmaps: RefCell<Box<[CachedWorldgenHeightmaps]>>

random: RandomSource

Implementations

impl<'a> WorldGenRegion<'a>

pub fn new( context: &'a WorldGenContext, step: &'a ChunkStep, cache: &'a StaticCache2D<Arc<ChunkHolder>>, center: ChunkPos, random: RandomSource, ) -> Self

Creates a new region over the chunks collected for a generation step.

pub const fn center(&self) -> ChunkPos

Returns the center chunk being generated.

pub const fn random_mut(&mut self) -> &mut RandomSource

Returns the random source exposed by vanilla WorldGenRegion.getRandom().

pub const fn min_y(&self) -> i32

Returns the minimum build height.

pub const fn height(&self) -> i32

Returns the world height.

pub fn generation_min_y(&self) -> i32

Returns the minimum Y coordinate used by vanilla WorldGenerationContext.

pub fn generation_height(&self) -> i32

Returns the vertical generation depth used by vanilla WorldGenerationContext.

pub const fn sea_level(&self) -> i32

Returns this dimension’s sea level.

pub fn seed(&self) -> i64

Returns the world seed.

pub fn weak_world(&self) -> Weak<World>

Returns the weak world reference used by generated chunks and entities.

pub const fn block_light_at(&self, _pos: BlockPos) -> u8

Returns block light as seen by feature-stage worldgen.

Vanilla routes this through the level light engine from WorldGenRegion, but block light is not generated for the feature-stage proto chunks. Treating the region as dark keeps snow and freeze checks aligned with vanilla feature placement.

pub const fn max_y_exclusive(&self) -> i32

Returns the exclusive maximum build height.

pub const fn is_outside_build_height(&self, y: i32) -> bool

Checks if a Y coordinate is outside the build height.

pub const fn required_status_at( &self, chunk_x: i32, chunk_z: i32, ) -> Option<ChunkStatus>

Returns the strongest status directly available for a chunk position in this step.

pub const fn can_write_to_chunk(&self, chunk_x: i32, chunk_z: i32) -> bool

Returns whether block writes are allowed in the given chunk.

pub(crate) fn try_chunk( &self, chunk_x: i32, chunk_z: i32, status: ChunkStatus, ) -> Option<WorldGenChunkRef<'a>>

Gets a chunk if the step declares enough direct dependency status for it.

pub(crate) fn chunk( &self, chunk_x: i32, chunk_z: i32, status: ChunkStatus, ) -> WorldGenChunkRef<'a>

Gets a chunk or panics if generation requested an undeclared dependency.

Panics

Panics if the chunk is outside this step’s direct dependencies, if the requested status is higher than the dependency contract, or if the holder has not reached the declared status. Those cases indicate a chunk-pyramid or scheduler bug.

fn with_cached_chunk<R>( &self, chunk_x: i32, chunk_z: i32, status: ChunkStatus, f: impl FnOnce(WorldGenChunkRef<'_>) -> R, ) -> R

fn chunk_cache_index(&self, chunk_x: i32, chunk_z: i32) -> Option<usize>

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

Gets a block state through the region dependency contract.

Panics

Panics if the position’s chunk is outside this step’s direct dependencies.

pub fn block_entity(&self, pos: BlockPos) -> Option<SharedBlockEntity>

Gets a block entity through the region dependency contract.

Panics

Panics if the position’s chunk is outside this step’s direct dependencies.

pub fn noise_biome_id(&self, quart_x: i32, quart_y: i32, quart_z: i32) -> u16

Gets the biome id at quart coordinates through the region dependency contract.

The vertical quart coordinate is clamped to the chunk’s biome section range, matching vanilla ChunkAccess.getNoiseBiome.

Panics

Panics if the position’s chunk is outside this step’s direct dependencies.

pub fn set_block_state( &self, pos: BlockPos, state: BlockStateId, flags: UpdateFlags, ) -> bool

Sets a block state if the position is inside the step’s write radius.

Returns whether the write was accepted by the region. Positions outside the write radius are rejected without touching chunk data, matching vanilla’s WorldGenRegion.ensureCanWrite gate.

Panics

Panics if a position inside the write radius is not covered by this step’s direct dependencies, or if the holder has not reached the declared status.

fn postprocess_pos_for_state( state: BlockStateId, pos: BlockPos, ) -> Option<BlockPos>

Mirrors the vanilla Blocks post-process hooks that can affect worldgen output.

Vanilla hardcodes these callbacks in Blocks.java: mushrooms postprocess themselves, while soul sand and magma blocks postprocess the block above.

pub fn set_block_entity_data( &self, pos: BlockPos, block_entity_type: BlockEntityTypeRef, state: BlockStateId, nbt: NbtCompound, ) -> bool

Attaches block entity data at a writable worldgen position.

This mirrors vanilla’s feature paths that place a block first, then configure its block entity. If Steel does not have concrete behavior for the type yet, the raw fallback keeps the NBT intact for later save/load.

pub fn remove_block_entity(&self, pos: BlockPos) -> bool

Removes block entity data at a writable worldgen position.

pub fn add_fresh_entity(&self, entity: SharedEntity) -> bool

Adds an entity to the chunk that owns its position.

Vanilla WorldGenRegion.addFreshEntity does not call ensureCanWrite, so entity insertion is allowed anywhere covered by the generation step’s chunk dependencies.

pub fn schedule_block_tick( &self, pos: BlockPos, block: BlockRef, _delay: i32, priority: TickPriority, ) -> bool

Schedules a block tick in the chunk that owns the target position.

Vanilla WorldGenTickAccess resolves the owning chunk directly and does not apply WorldGenRegion.ensureCanWrite, so ticks can be recorded outside the block write radius as long as the generation step declared the chunk dependency.

pub fn schedule_block_tick_default( &self, pos: BlockPos, block: BlockRef, delay: i32, ) -> bool

Schedules a block tick with vanilla’s normal priority.

pub fn schedule_fluid_tick( &self, pos: BlockPos, fluid: FluidRef, _delay: i32, priority: TickPriority, ) -> bool

Schedules a fluid tick in the chunk that owns the target position.

This mirrors vanilla tick scheduling and intentionally does not apply the block write radius.

pub fn schedule_fluid_tick_default( &self, pos: BlockPos, fluid: FluidRef, delay: i32, ) -> bool

Schedules a fluid tick with vanilla’s normal priority.

pub fn mark_pos_for_postprocessing(&self, pos: BlockPos)

Marks a position for vanilla proto-chunk postprocessing after full promotion.

Panics

Panics if the target chunk is outside this step’s direct dependencies.

pub fn height_at(&self, heightmap_type: HeightmapType, x: i32, z: i32) -> i32

Gets the first available Y coordinate for a heightmap column.

Mirrors vanilla WorldGenRegion.getHeight, which requests the target chunk at EMPTY and then reads whichever generated status the step dependency cache already holds for that chunk.

fn cached_proto_height_at( &self, proto: &Chunk, heightmap_type: HeightmapType, chunk_x: i32, chunk_z: i32, column_index: usize, ) -> i32

fn proto_heightmap_columns( proto: &Chunk, heightmap_type: HeightmapType, ) -> Box<[i32; 256]>

fn invalidate_cached_worldgen_heightmaps(&self, chunk_x: i32, chunk_z: i32)

fn copy_heightmap_columns(heightmap: &Heightmap, min_y: i32) -> Box<[i32; 256]>

pub(crate) fn bulk_section_access_for_ore<'profile>( &self, profile: Option<&'profile RefCell<OreFeatureStats>>, ) -> WorldGenBulkSectionAccess<'_, 'a, 'profile>

fn writable_chunk_for_pos( &self, pos: BlockPos, action: &str, ) -> Option<(i32, i32, ChunkStatus)>

fn dependency_chunk_for_pos( &self, pos: BlockPos, action: &str, ) -> (i32, i32, ChunkStatus)

const fn chessboard_distance( center: ChunkPos, chunk_x: i32, chunk_z: i32, ) -> usize

fn biome_quart_y_indices( min_y: i32, section_count: usize, quart_y: i32, ) -> (usize, usize)

Trait Implementations

impl LevelAccessor for WorldGenRegion<'_>

fn set_block_state( &self, pos: BlockPos, state: BlockStateId, flags: UpdateFlags, ) -> bool

Sets a block state with vanilla update flags.

fn play_block_sound( &self, sound: SoundEventRef, pos: BlockPos, volume: f32, pitch: f32, exclude: Option<i32>, )

Plays a block sound when this level surface supports runtime side effects.

fn game_event( &self, event: GameEventRef, pos: BlockPos, context: &GameEventContext<'_>, )

Dispatches a game event when this level surface supports runtime listeners.

impl LevelReader for WorldGenRegion<'_>

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

Gets the block state at a position.

fn get_block_entity(&self, pos: BlockPos) -> Option<SharedBlockEntity>

Gets the block entity at a position when this level surface supports it

fn is_face_sturdy_for( &self, state: BlockStateId, pos: BlockPos, direction: Direction, support_type: SupportType, ) -> bool

Mirrors vanilla BlockState.isFaceSturdy for a specific support type.

fn raw_brightness(&self, pos: BlockPos, sky_darkening: u8) -> u8

Returns vanilla raw brightness at a position after sky darkening.

fn can_see_sky(&self, pos: BlockPos) -> bool

Returns vanilla BlockAndLightGetter.canSeeSky.

fn ambient_light(&self) -> f32

Returns this dimension’s vanilla ambient light factor.

fn min_y(&self) -> i32

Returns the minimum build height.

fn height(&self) -> i32

Returns the build height.

fn is_face_sturdy( &self, state: BlockStateId, pos: BlockPos, direction: Direction, ) -> bool

Mirrors vanilla BlockState.isFaceSturdy with full-face support.

fn max_y_exclusive(&self) -> i32

Returns the exclusive maximum build height.

fn is_outside_build_height(&self, y: i32) -> bool

Checks if a Y coordinate is outside build height.

fn max_local_raw_brightness(&self, pos: BlockPos, sky_darkening: u8) -> u8

Returns vanilla LevelReader.getMaxLocalRawBrightness.

fn light_level_dependent_magic_value(&self, pos: BlockPos) -> f32

Returns vanilla LevelReader.getLightLevelDependentMagicValue.

fn pathfinding_cost_from_light_levels(&self, pos: BlockPos) -> f32

Returns vanilla LevelReader.getPathfindingCostFromLightLevels.

impl ScheduledTickAccess for WorldGenRegion<'_>

fn fluid_tick_delay(&self, fluid: FluidRef) -> i32

Returns the fluid tick delay in this level.

fn schedule_block_tick_default( &self, pos: BlockPos, block: BlockRef, delay: i32, ) -> bool

Schedules a block tick using vanilla’s default priority.

fn schedule_fluid_tick_default( &self, pos: BlockPos, fluid: FluidRef, delay: i32, ) -> bool

Schedules a fluid tick using vanilla’s default priority.

fn has_scheduled_block_tick(&self, pos: BlockPos, block: BlockRef) -> bool

Returns whether a tick is already scheduled for the same (pos, block).

fn will_tick_block_this_tick(&self, pos: BlockPos, block: BlockRef) -> bool

Returns whether the same (pos, block) was selected for this tick and has not started.

fn will_tick_fluid_this_tick(&self, pos: BlockPos, fluid: FluidRef) -> bool

Returns whether the same (pos, fluid) was selected for this tick and has not started.