Struct Schematic

pub struct Schematic { /* private fields */ }

A struct holding infomation about a schematic

Implementations

impl Schematic

pub fn new(data_version: i32, size_x: u16, size_y: u16, size_z: u16) -> Self

Initialize a new schematic filled with minecraft:air

Examples found in repository

examples/test.rs (line 4)

fn main() {
    let mut schem = mcschem::Schematic::new(mcschem::data_version::MC_1_18_2, 1, 2, 1);

    schem.set_block_entity(
        0, 0, 0,
        mcschem::Block::from_str("minecraft:barrel[facing=north,open=false]").unwrap(),
        mcschem::BlockEntity::Barrel {
            items: mcschem::utils::barrel_ss(3)
        }
    );

    schem.set_block_entity(
        0, 1, 0,
        mcschem::Block::from_str("minecraft:oak_sign[rotation=8,waterlogged=false]").unwrap(),
        mcschem::BlockEntity::SignPre1D20 {
            glowing: true,
            color: "lime".to_string(),
            line_1: r#"["Line 1"]"#.to_string(),
            line_2: r#"["Line 2"]"#.to_string(),
            line_3: r#"["Line 3"]"#.to_string(),
            line_4: r#"["Line 4"]"#.to_string()
        }
    );

    let mut file = std::fs::File::create("schematic.schem").unwrap();
    schem.export(&mut file).unwrap();
}

pub fn set_block(&mut self, x: usize, y: usize, z: usize, block: Block)

Sets a block in the schematic

pub fn set_block_entity( &mut self, x: usize, y: usize, z: usize, block: Block, be: BlockEntity, )

Sets a block entity in the schematic

Examples found in repository

examples/test.rs (lines 6-12)

fn main() {
    let mut schem = mcschem::Schematic::new(mcschem::data_version::MC_1_18_2, 1, 2, 1);

    schem.set_block_entity(
        0, 0, 0,
        mcschem::Block::from_str("minecraft:barrel[facing=north,open=false]").unwrap(),
        mcschem::BlockEntity::Barrel {
            items: mcschem::utils::barrel_ss(3)
        }
    );

    schem.set_block_entity(
        0, 1, 0,
        mcschem::Block::from_str("minecraft:oak_sign[rotation=8,waterlogged=false]").unwrap(),
        mcschem::BlockEntity::SignPre1D20 {
            glowing: true,
            color: "lime".to_string(),
            line_1: r#"["Line 1"]"#.to_string(),
            line_2: r#"["Line 2"]"#.to_string(),
            line_3: r#"["Line 3"]"#.to_string(),
            line_4: r#"["Line 4"]"#.to_string()
        }
    );

    let mut file = std::fs::File::create("schematic.schem").unwrap();
    schem.export(&mut file).unwrap();
}

pub fn export<W: Write>(&self, writer: &mut W) -> Result<(), NbtIoError>

Export the schematic to a writer

Examples found in repository

examples/test.rs (line 28)

fn main() {
    let mut schem = mcschem::Schematic::new(mcschem::data_version::MC_1_18_2, 1, 2, 1);

    schem.set_block_entity(
        0, 0, 0,
        mcschem::Block::from_str("minecraft:barrel[facing=north,open=false]").unwrap(),
        mcschem::BlockEntity::Barrel {
            items: mcschem::utils::barrel_ss(3)
        }
    );

    schem.set_block_entity(
        0, 1, 0,
        mcschem::Block::from_str("minecraft:oak_sign[rotation=8,waterlogged=false]").unwrap(),
        mcschem::BlockEntity::SignPre1D20 {
            glowing: true,
            color: "lime".to_string(),
            line_1: r#"["Line 1"]"#.to_string(),
            line_2: r#"["Line 2"]"#.to_string(),
            line_3: r#"["Line 3"]"#.to_string(),
            line_4: r#"["Line 4"]"#.to_string()
        }
    );

    let mut file = std::fs::File::create("schematic.schem").unwrap();
    schem.export(&mut file).unwrap();
}

Trait Implementations

impl Clone for Schematic

fn clone(&self) -> Schematic

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Schematic

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

Formats the value using the given formatter.