Struct McStructureFile 

pub struct McStructureFile {
    pub size: McStructureSize,
    pub world_origin: [i32; 3],
    pub palette: Vec<McStructurePaletteEntry>,
    pub primary_indices: Vec<i32>,
    pub secondary_indices: Vec<i32>,
    pub entities: Vec<NbtTag>,
    pub block_position_data: IndexMap<String, NbtTag>,
}

In-memory representation of a Bedrock .mcstructure file.

Fields

size: McStructureSize

Structure dimensions.

world_origin: [i32; 3]

World origin saved in the file.

palette: Vec<McStructurePaletteEntry>

Shared block palette.

primary_indices: Vec<i32>

Primary block layer indices in structure order.

secondary_indices: Vec<i32>

Secondary block layer indices in structure order.

entities: Vec<NbtTag>

Entity NBT entries.

block_position_data: IndexMap<String, NbtTag>

Raw block_position_data compound.

Implementations

impl McStructureFile

pub fn new_air(size: McStructureSize, world_origin: [i32; 3]) -> Result<Self>

Creates an empty air structure with the requested size.

pub fn from_bytes(bytes: &[u8]) -> Result<Self>

Reads a structure from uncompressed little-endian NBT bytes.

pub fn to_bytes(&self) -> Result<Vec<u8>>

Serializes this structure as uncompressed little-endian NBT bytes.

pub fn read_from_path(path: &Path) -> Result<Self>

Reads a .mcstructure file from disk.

pub fn write_to_path(&self, path: &Path) -> Result<()>

Writes this structure to disk as a .mcstructure file.

pub fn from_nbt(root: NbtTag) -> Result<Self>

Parses a structure from its root NBT tag.

pub fn to_nbt(&self) -> Result<NbtTag>

Converts this structure to a root NBT tag.

pub fn primary_index_at(&self, x: i32, y: i32, z: i32) -> Result<i32>

Returns the primary-layer palette index at a relative block position.

pub fn blocks(&self) -> Result<Vec<McStructureBlock>>

Iterates every block position in structure order.

pub fn palette_entry_or_air(&self, index: i32) -> McStructurePaletteEntry

Returns the palette entry for a structure-layer index.

pub fn index_is_air(&self, index: i32) -> bool

Returns whether a structure-layer index resolves to air.

pub fn target_chunks( &self, placement: McStructurePlacement, ) -> Result<BTreeSet<ChunkPos>>

Computes all chunks touched by this structure placement.

pub fn write_to_world_blocking<S>( &self, world: &BedrockWorld<S>, placement: McStructurePlacement, guard: &WriteGuard, progress: impl FnMut(McStructureWriteProgress), ) -> Result<McStructureWriteResult>

where S: WorldStorageHandle,

Merges this structure’s block layers into a world.

Block palette data, secondary block layers, and block-position NBT data are written. Entity placement is intentionally not performed because Bedrock actor storage requires stable UniqueID and digest updates.

pub fn from_world_region_blocking( world: &BedrockWorld, dimension: Dimension, min_x: i32, min_y: i32, min_z: i32, size: McStructureSize, ) -> Result<Self>

Builds a structure by sampling decoded blocks from a world.

Trait Implementations

impl Clone for McStructureFile

fn clone(&self) -> McStructureFile

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for McStructureFile

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for McStructureFile

fn eq(&self, other: &McStructureFile) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for McStructureFile