From f79edb462c3d37b343f4be1a70b8f58a63d8dd07 Mon Sep 17 00:00:00 2001 From: Matthias Schiffer Date: Mon, 8 Jan 2024 02:34:39 +0100 Subject: [PATCH] core/common: add better explanation to file meta version definitions --- src/core/common.rs | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/src/core/common.rs b/src/core/common.rs index 39c8e54..d17056f 100644 --- a/src/core/common.rs +++ b/src/core/common.rs @@ -14,12 +14,21 @@ use crate::{io::fs::FileMetaVersion, resource::Biome, types::*, world::layer}; /// Increase to force regeneration of all output files /// MinedMap processed region data version number +/// +/// Increase when the generation of processed regions from region data changes +/// (usually because of updated resource data) pub const REGION_FILE_META_VERSION: FileMetaVersion = FileMetaVersion(0); /// MinedMap map tile data version number +/// +/// Increase when the generation of map tiles from processed regions changes +/// (because of code changes in tile generation) pub const MAP_FILE_META_VERSION: FileMetaVersion = FileMetaVersion(0); /// MinedMap lightmap data version number +/// +/// Increase when the generation of lightmap tiles from region data changes +/// (usually because of updated resource data) pub const LIGHTMAP_FILE_META_VERSION: FileMetaVersion = FileMetaVersion(0); /// Coordinate pair of a generated tile