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. Serialized to JSON and sent across the ABI via Registry::register_dimension (in yog-api), which the Java host parses to register (or patch) a LevelStem/DimensionType entry 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.

pub fn to_json(&self) -> String

Serialize to the JSON wire format sent to the Java host.

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<'de> Deserialize<'de> for YogDimensionDef

where YogDimensionDef: Default,

fn deserialize<__D>( __deserializer: __D, ) -> Result<YogDimensionDef, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for YogDimensionDef

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.