Struct GeneratedChunk 

pub struct GeneratedChunk {
    pub generator: String,
    pub chunk_x: i32,
    pub chunk_z: i32,
    pub min_y: i32,
    pub height: i32,
    pub palette: Vec<String>,
    pub cells: Vec<u8>,
}

A chunk column a generator fills (the world/generation/chunk event, keyed by generator): where it is, and every block placed so far — a palette and a cell per block, like the game’s chunk sections, so the host sets them a section at a time. Several handlers fill one column in turn (terrain, then a mod’s ores).

Fields

generator: String

The generator type (mymod:custom_terrain).

chunk_x: i32

In chunks, not blocks.

chunk_z: i32

min_y: i32

The dimension type’s min_y and height.

height: i32

palette: Vec<String>

The block ids the cells name: cell value n is palette[n - 1].

cells: Vec<u8>

One little-endian u16 per block, Y then Z then X (CELL each; 0: nothing placed); empty until the first block.

Implementations

impl GeneratedChunk

pub fn set_block(&mut self, x: i32, y: i32, z: i32, block_id: &str) -> bool

Places block_id at local x/z (0..16), world y (between min_y and min_y + height) over whatever was there; false outside the column (or past u16::MAX distinct blocks).

pub fn block(&self, x: i32, y: i32, z: i32) -> Option<&str>

The block placed at local x/z, world y, if any.

pub fn placed(&self) -> impl Iterator<Item = (i32, i32, i32, &str)>

Every block placed, as (local x, world y, local z, id), Y then Z then X.

Trait Implementations

impl Clone for GeneratedChunk

fn clone(&self) -> GeneratedChunk

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for GeneratedChunk

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

Formats the value using the given formatter.

impl Default for GeneratedChunk

fn default() -> GeneratedChunk

Returns the “default value” for a type.

impl Event for GeneratedChunk

const ADDRESS: &'static str = ids::event_world_generation::CHUNK

Where it’s emitted after the game did it.

const PRE: Option<&'static str> = None

Where it’s emitted before — a handler’s cancel stops it — if it can be stopped.

const KEY: Option<&'static str>

The field whose value picks the event’s branch (entity_type: each type’s ticks go to …/tick/<type>), if it’s keyed — see crate::keyed.

fn key(&self) -> Option<&str>

The key field’s value, if it’s keyed.

fn address(&self) -> u32

Event::target’s number — the type’s own address cached.

fn pre_address(&self) -> Option<u32>

Event::pre_target’s number.

fn target(&self) -> String

Where this event goes after the game did it: the address, or its branch for the key.

fn pre_target(&self) -> Option<String>

Where it goes before, if it can be stopped.

impl Fields for GeneratedChunk

const FIELDS: &'static [(&'static str, &'static str)]

impl PartialEq for GeneratedChunk

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

Equality operator ==.

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

Inequality operator !=.

impl Schema for GeneratedChunk

fn encode(&self, __yog_w: &mut Writer)

Writes itself in the binary form, straight — Schema::write’s value encoded, unless the type knows better (derived ones do).

fn decode(__yog_d: &mut Decoder<'_>) -> Option<GeneratedChunk>

Reads itself from the binary form, straight; None when it isn’t what Schema::encode writes — then read_bytes reads the slow way, which says what’s wrong. Through a value unless the type knows better (derived ones do).

fn pack(&self, __yog_p: &mut Packer)

Packs itself into a frame (crate::frame): its binary form as bytes, unless the type packs itself (derived ones and plain types do).

fn unpack(__yog_u: &mut Unpacker<'_>) -> Option<GeneratedChunk>

Reads itself out of a frame; None if the bytes aren’t what Schema::pack writes.

fn shape() -> Shape

What the format looks like.

fn read(v: &ValueRef<'_>, cx: &mut Reader<'_>) -> Option<GeneratedChunk>

Reads v. Problems go to cx at its current path; None when the value couldn’t be read (the problem is in cx).

fn write(&self) -> Value

The value, as the format writes it.

fn absent() -> Option<Self>

The value of a field that isn’t there — None: the field is required.

fn skip(&self) -> bool

Whether a struct leaves this field out when writing it.

fn pack_list(items: &[Self], p: &mut Packer)

A list of these packed: a count, then each one (floats raw).

fn unpack_list(u: &mut Unpacker<'_>) -> Option<Vec<Self>>

A list of these out of a frame.

fn encode_list(items: &[Self], w: &mut Writer)

A list of these written straight (numbers pack theirs).

fn decode_list(d: &mut Decoder<'_>) -> Option<Vec<Self>>

A list of these read straight.

impl StructuralPartialEq for GeneratedChunk