neocturne/MinedMap
1
0
Fork 0
mirror of https://github.com/neocturne/MinedMap.git synced 2025-07-09 09:09:07 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

treewide: add more documentation

Browse source
This commit is contained in:
Matthias Schiffer 2023-02-12 20:59:23 +01:00
parent 5ee114ed0a
commit 493608ebc8
Signed by: neocturne
GPG key ID: 16EF3F64CB201D9C
3 changed files with 53 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

17
src/world/section.rs
View file

@ -3,6 +3,11 @@ use anyhow::{bail, Context, Result};
use super::de;
use crate::{resource, types::*};
/// Determine the number of bits required for indexing into a palette of a given length
///
/// This is basically a base-2 logarithm, with clamping to a minimum value and
/// check against a maximum value. If the result would be greater than the passed
/// `max` value, [None] is returned.
fn palette_bits(len: usize, min: u8, max: u8) -> Option<u8> {
let mut bits = min;
while (1 << bits) < len {
@ -16,10 +21,16 @@ fn palette_bits(len: usize, min: u8, max: u8) -> Option<u8> {
Some(bits)
}
/// Trait for common functions of [PaletteSection] and [OldSection]
pub trait Section {
fn get_block_id(&self, coords: BlockCoords) -> Result<&str>;
}
/// Minecraft v1.18+ section biome data
///
/// The biome data is part of the section structure in Minecraft v1.18+, with
/// the biomes laid out as an array of indices into a palette, similar to the
/// v1.13+ block data.
#[derive(Debug)]
pub struct PaletteSectionBiomes<'a> {
_biomes: Option<&'a fastnbt::LongArray>,
@ -28,6 +39,7 @@ pub struct PaletteSectionBiomes<'a> {
}
impl<'a> PaletteSectionBiomes<'a> {
/// Constructs a new [PaletteSectionBiomes] from deserialized data structures
pub fn new(biomes: Option<&'a fastnbt::LongArray>, palette: &'a Vec<String>) -> Result<Self> {
let bits = palette_bits(palette.len(), 1, 6).context("Unsupported block palette size")?;
@ -47,6 +59,7 @@ impl<'a> PaletteSectionBiomes<'a> {
}
}
/// Minecraft v1.13+ section block data
#[derive(Debug)]
pub struct PaletteSection<'a> {
block_states: Option<&'a fastnbt::LongArray>,
@ -56,6 +69,7 @@ pub struct PaletteSection<'a> {
}
impl<'a> PaletteSection<'a> {
/// Constructs a new [PaletteSection] from deserialized data structures
pub fn new(
data_version: u32,
block_states: Option<&'a fastnbt::LongArray>,
@ -85,6 +99,7 @@ impl<'a> PaletteSection<'a> {
})
}
/// Looks up the block type palette index at the given coordinates
fn get_palette_index(&self, coords: BlockCoords) -> usize {
let Some(block_states) = self.block_states else {
return 0;
@ -127,6 +142,7 @@ impl<'a> Section for PaletteSection<'a> {
}
}
/// Pre-1.13 section block data
#[derive(Debug)]
pub struct OldSection<'a> {
blocks: &'a fastnbt::ByteArray,
@ -134,6 +150,7 @@ pub struct OldSection<'a> {
}
impl<'a> OldSection<'a> {
/// Constructs a new [OldSection] from deserialized data structures
pub fn new(blocks: &'a fastnbt::ByteArray, data: &'a fastnbt::ByteArray) -> Result<Self> {
use BLOCKS_PER_CHUNK as N;