Struct YogDimensionDef 

pub struct YogDimensionDef {
    pub id: String,
    pub dimension_type: YogDimensionTypeDef,
    pub generator_type: Option<String>,
    pub biome: String,
    pub structures: bool,
    pub features: bool,
    pub mob_spawning: bool,
    pub extra: HashMap<String, String>,
}

A dimension definition — what a mod registers to create a custom dimension, or to patch an existing (including vanilla) one. Sent as Yog Data via Registry::register_dimension (in yog-api); the host registers (or patches) a LevelStem/DimensionType entry from it at mod-init time.

The actual ServerLevel (world data) is created lazily at runtime — see the crate-level docs and Registry::register_chunk_generator.

Fields

id: String

Registry id. A new id (e.g. "mymod:my_dim") creates a custom dimension; a vanilla id ("minecraft:overworld", etc.) patches that dimension’s type/generator instead.

dimension_type: YogDimensionTypeDef

generator_type: Option<String>

Id of a generator type registered via Registry::register_chunk_generator (e.g. "mymod:custom_terrain") that this dimension should use. None keeps the dimension’s existing/vanilla generator.

biome: String

The one biome the dimension is made of ("minecraft:plains"): its mobs, its features, the structures that may start in it.

structures: bool

Structures (villages, …) may generate. Only for dimensions with a registered generator.

features: bool

The biome’s features (trees, flowers, ores) are placed. Only for dimensions with a registered generator.

mob_spawning: bool

Mobs spawn naturally (a registered generator also offers none to the spawner when off).

extra: HashMap<String, String>

Extra platform/metadata mods want the host to know about (arbitrary JSON-string values), for anything not modeled by dimension_type.

Implementations

impl YogDimensionDef

pub fn new(id: impl Into<String>) -> YogDimensionDef

Start a new definition with default (overworld-like) type properties.

pub fn dimension_type( self, dimension_type: YogDimensionTypeDef, ) -> YogDimensionDef

Replace the dimension type properties.

pub fn generator_type( self, generator_type_id: impl Into<String>, ) -> YogDimensionDef

Use the generator type registered under this id (see Registry::register_chunk_generator).

pub fn biome(self, biome: impl Into<String>) -> YogDimensionDef

The biome the dimension is made of.

pub fn structures(self, on: bool) -> YogDimensionDef

Whether structures generate (default: yes).

pub fn features(self, on: bool) -> YogDimensionDef

Whether the biome’s features are placed (default: yes).

pub fn mob_spawning(self, on: bool) -> YogDimensionDef

Whether mobs spawn (default: yes).

pub fn with_extra( self, key: impl Into<String>, value: impl Into<String>, ) -> YogDimensionDef

Set an extra metadata property.

Trait Implementations

impl Clone for YogDimensionDef

fn clone(&self) -> YogDimensionDef

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for YogDimensionDef

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

Formats the value using the given formatter.

impl Default for YogDimensionDef

fn default() -> YogDimensionDef

Returns the “default value” for a type.

impl Fields for YogDimensionDef

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

impl PartialEq for YogDimensionDef

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

Equality operator ==.

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

Inequality operator !=.

impl Schema for YogDimensionDef

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<YogDimensionDef>

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<YogDimensionDef>

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<YogDimensionDef>

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 YogDimensionDef