cubiomes 0.3.3

A safe rust wrapper for the cubiome 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

use super::range::Scale;
use cubiomes_sys::Pos;

///A 2d position inside minecraft
#[derive(Default, Debug, Clone, Copy, PartialEq, Eq, Hash, PartialOrd, Ord)]
pub struct BlockPosition {
    /// The x axis of the position
    pub x: i32,
    /// The z axis of the position
    pub z: i32,
}

impl BlockPosition {
    /// Creates a new instance of a minecraft position at block scale
    #[must_use]
    pub fn new(x: i32, z: i32) -> Self {
        Self { x, z }
    }

    /// Creates a new instance of minecraft position from coordinates at the
    /// specific [Scale]
    #[must_use]
    pub fn from_scaled(x: i32, z: i32, scale: Scale) -> Self {
        Self {
            x: scale.unscale_coord(x),
            z: scale.unscale_coord(z),
        }
    }

    /// Scales this minecraft position to a [Scale]
    #[must_use]
    pub fn as_scaled(&self, scale: Scale) -> (i32, i32) {
        (scale.scale_coord(self.x), scale.scale_coord(self.z))
    }

    /// Scales the position down by a given number
    ///
    /// Internally divides both axis by scale
    #[must_use]
    pub fn scale_by_num(&self, scale: i32) -> (i32, i32) {
        (self.x.div_euclid(scale), self.z.div_euclid(scale))
    }
}

impl From<Pos> for BlockPosition {
    fn from(value: Pos) -> Self {
        Self {
            x: value.x,
            z: value.z,
        }
    }
}