Enum veloren_world::sim::WorldFile

#[repr(u32)]
pub enum WorldFile {
    Veloren0_5_0(WorldMap_0_5_0),
    Veloren0_7_0(WorldMap_0_7_0),
}

WORLD MAP.

A way to store certain components between runs of map generation. Only intended for development purposes–no attempt is made to detect map invalidation or make sure that the map is synchronized with updates to noise-rs, changes to other parameters, etc.

The map is versioned to enable format detection between versions of Veloren, so that when we update the map format we don’t break existing maps (or at least, we will try hard not to break maps between versions; if we can’t avoid it, we can at least give a reasonable error message).

NOTE: We rely somewhat heavily on the implementation specifics of bincode to make sure this is backwards compatible. When adding new variants here, Be very careful to make sure tha the old variants are preserved in the correct order and with the correct names and indices, and make sure to keep the #[repr(u32)]!

All non-legacy versions of world files should (ideally) fit in this format. Since the format contains a version and is designed to be extensible backwards-compatibly, the only reason not to use this forever would be if we decided to move away from BinCode, or store data across multiple files (or something else weird I guess).

Update this when you add a new map version.

Variants

Veloren0_5_0(WorldMap_0_5_0)

Veloren0_7_0(WorldMap_0_7_0)

Implementations

impl WorldFile

pub fn new(map: ModernMap) -> Self

Turns map data from the latest version into a versioned WorldFile ready for serialization. Whenever a new map is updated, just change the variant we construct here to make sure we’re using the latest map version.

pub fn into_modern(self) -> Result<ModernMap, WorldFileError>

Turns a WorldFile into the latest version. Whenever a new map version is added, just add it to this match statement.

Trait Implementations

impl Asset for WorldFile

type Loader = BincodeLoader

Specifies a way to convert raw bytes into the asset.

const EXTENSION: &'static str = "bin"

Use this field if your asset only uses one extension.

const EXTENSIONS: &'static [&'static str] = _

This field enables you to specify multiple extension for an asset.

fn default_value( id: &SharedString, error: Box<dyn Error + Send + Sync>, ) -> Result<Self, Box<dyn Error + Send + Sync>>

Specifies a eventual default value to use if an asset fails to load. If this method returns Ok, the returned value is used as an asset. In particular, if this method always returns Ok, AssetCache::load is guaranteed not to fail.

const HOT_RELOADED: bool = true

If false, disable hot-reloading for assets of this type (true by default). This avoids having to lock the asset to read it (ie it makes [Handle::read] a noop)

impl<'de> Deserialize<'de> for WorldFile

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for WorldFile

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

where __S: Serializer,

Serialize this value into the given Serde serializer.