chunkgen 0.2.0

Minecraft world generation library
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145

use crate::world::chunk::heightmap::HeightmapType;

#[derive(Debug, PartialEq, Eq, PartialOrd, Ord, Clone, Copy)]
pub enum ChunkStatus {
    Empty,
    StructureStarts,
    StructureReferences,
    Biomes,
    Terrain,
    Features,
    InitializeLight,
    Light,
    Spawn,
    Full,
}

impl ChunkStatus {
    pub const fn get_index(self) -> usize {
        self as usize
    }

    pub const fn next(self) -> Option<Self> {
        match self {
            Self::Empty => Some(Self::StructureStarts),
            Self::StructureStarts => Some(Self::StructureReferences),
            Self::StructureReferences => Some(Self::Biomes),
            Self::Biomes => Some(Self::Terrain),
            Self::Terrain => Some(Self::Features),
            Self::Features => Some(Self::InitializeLight),
            Self::InitializeLight => Some(Self::Light),
            Self::Light => Some(Self::Spawn),
            Self::Spawn => Some(Self::Full),
            Self::Full => None,
        }
    }

    pub const fn parent(self) -> Option<Self> {
        match self {
            Self::Empty => None,
            Self::StructureStarts => Some(Self::Empty),
            Self::StructureReferences => Some(Self::StructureStarts),
            Self::Biomes => Some(Self::StructureReferences),
            Self::Terrain => Some(Self::Biomes),
            Self::Features => Some(Self::Terrain),
            Self::InitializeLight => Some(Self::Features),
            Self::Light => Some(Self::InitializeLight),
            Self::Spawn => Some(Self::Light),
            Self::Full => Some(Self::Spawn),
        }
    }

    pub const fn heightmaps_after(self) -> &'static [HeightmapType] {
        match self {
            Self::Empty | Self::StructureStarts | Self::StructureReferences | Self::Biomes => {
                HeightmapType::worldgen_types()
            }
            Self::Terrain
            | Self::Features
            | Self::InitializeLight
            | Self::Light
            | Self::Spawn
            | Self::Full => HeightmapType::final_types(),
        }
    }

    pub const fn requirements(self) -> &'static [(ChunkStatus, usize)] {
        match self {
            Self::Empty | Self::StructureStarts | Self::InitializeLight | Self::Full => &[],
            Self::StructureReferences | Self::Biomes => &[(Self::StructureStarts, 8)],
            Self::Terrain => &[(Self::StructureStarts, 8), (Self::Biomes, 1)],
            Self::Features => &[(Self::StructureStarts, 8), (Self::Terrain, 1)],
            Self::Light => &[(Self::InitializeLight, 1)],
            Self::Spawn => &[(Self::Biomes, 1)],
        }
    }
}

impl TryFrom<usize> for ChunkStatus {
    type Error = ();

    fn try_from(value: usize) -> Result<Self, Self::Error> {
        Ok(match value {
            0 => Self::Empty,
            1 => Self::StructureStarts,
            2 => Self::StructureReferences,
            3 => Self::Biomes,
            4 => Self::Terrain,
            5 => Self::Features,
            6 => Self::InitializeLight,
            7 => Self::Light,
            8 => Self::Spawn,
            9 => Self::Full,
            _ => return Err(()),
        })
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn index_roundtrips() {
        for index in 0..=9 {
            let status = ChunkStatus::try_from(index).expect("valid index");
            assert_eq!(status.get_index(), index);
        }
        assert_eq!(ChunkStatus::try_from(10), Err(()));
    }

    #[test]
    fn next_and_parent_are_inverses() {
        let mut status = ChunkStatus::Empty;
        while let Some(next) = status.next() {
            assert_eq!(next.parent(), Some(status));
            status = next;
        }
        assert_eq!(status, ChunkStatus::Full);
    }

    #[test]
    fn requirements_match_vanilla_generation_pyramid() {
        assert_eq!(ChunkStatus::Empty.requirements(), &[]);
        assert_eq!(
            ChunkStatus::StructureReferences.requirements(),
            &[(ChunkStatus::StructureStarts, 8)]
        );
        assert_eq!(
            ChunkStatus::Terrain.requirements(),
            &[(ChunkStatus::StructureStarts, 8), (ChunkStatus::Biomes, 1)]
        );
        assert_eq!(
            ChunkStatus::Features.requirements(),
            &[(ChunkStatus::StructureStarts, 8), (ChunkStatus::Terrain, 1)]
        );
        assert_eq!(
            ChunkStatus::Light.requirements(),
            &[(ChunkStatus::InitializeLight, 1)]
        );
        assert_eq!(
            ChunkStatus::Spawn.requirements(),
            &[(ChunkStatus::Biomes, 1)]
        );
    }
}