mcrs 0.4.3

Interface with a local Minecraft server
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
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166

use std::{fmt, ops};

use crate::{Coordinate2D, Size};

/// 2D size in blocks.
///
/// Used by [`Heights`].
///
/// [`Heights`]: crate::Heights
#[derive(Clone, Copy, Hash, PartialEq, Eq)]
pub struct Size2D {
    pub x: u32,
    pub z: u32,
}

impl Size2D {
    pub const fn new(x: u32, z: u32) -> Self {
        Self { x, z }
    }

    /// Returns `true` if the **offset** [`Coordinate2D`] is within the size.
    pub fn contains(self, coordinate: impl Into<Coordinate2D>) -> bool {
        let coordinate = coordinate.into();
        (0..self.x as i32).contains(&coordinate.x) && (0..self.z as i32).contains(&coordinate.z)
    }

    /// Convert a [`Heights`] index to an **offset** [`Coordinate2D`].
    ///
    /// [`Heights`]: crate::Heights
    pub const fn index_to_offset(self, index: usize) -> Coordinate2D {
        let z = (index % self.z as usize) as i32;
        let x = (index / self.z as usize) as i32;
        Coordinate2D { x, z }
    }

    /// Convert an **offset** [`Coordinate2D`] to a [`Heights`] index.
    ///
    /// [`Heights`]: crate::Heights
    pub fn offset_to_index(self, coordinate: impl Into<Coordinate2D>) -> usize {
        let coordinate = coordinate.into();
        coordinate.z as usize + coordinate.x as usize * self.z as usize
    }

    // Returns the amount of blocks in the flat area.
    pub fn area(self) -> usize {
        self.x as usize * self.z as usize
    }

    pub const fn with_height(self, height: u32) -> Size {
        Size {
            x: self.x,
            y: height,
            z: self.z,
        }
    }

    pub const fn flip_if(self, condition: bool) -> Self {
        if condition {
            Self::new(self.z, self.x)
        } else {
            self
        }
    }
}

impl fmt::Display for Size2D {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        write!(f, "{}x{}", self.x, self.z)
    }
}
impl fmt::Debug for Size2D {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        write!(f, "Size2D({}, {})", self.x, self.z)
    }
}

impl<T> ops::Add<T> for Size2D
where
    T: Into<Self>,
{
    type Output = Self;

    fn add(self, rhs: T) -> Self::Output {
        let rhs = rhs.into();
        Self {
            x: self.x + rhs.x,
            z: self.z + rhs.z,
        }
    }
}
impl<T> ops::Sub<T> for Size2D
where
    T: Into<Self>,
{
    type Output = Self;

    fn sub(self, rhs: T) -> Self::Output {
        let rhs = rhs.into();
        Self {
            x: self.x - rhs.x,
            z: self.z - rhs.z,
        }
    }
}

impl<T> ops::Mul<T> for Size2D
where
    T: Into<Self>,
{
    type Output = Self;

    fn mul(self, rhs: T) -> Self::Output {
        let rhs = rhs.into();
        Self {
            x: self.x * rhs.x,
            z: self.z * rhs.z,
        }
    }
}

impl ops::Mul<u32> for Size2D {
    type Output = Self;

    fn mul(self, rhs: u32) -> Self::Output {
        Self {
            x: self.x * rhs,
            z: self.z * rhs,
        }
    }
}
impl ops::Div<u32> for Size2D {
    type Output = Self;

    fn div(self, rhs: u32) -> Self::Output {
        Self {
            x: self.x / rhs,
            z: self.z / rhs,
        }
    }
}

impl From<[u32; 2]> for Size2D {
    fn from(value: [u32; 2]) -> Self {
        Self {
            x: value[0],
            z: value[1],
        }
    }
}
impl From<(u32, u32)> for Size2D {
    fn from(value: (u32, u32)) -> Self {
        Self {
            x: value.0,
            z: value.1,
        }
    }
}

impl From<Size> for Size2D {
    fn from(size: Size) -> Self {
        Self {
            x: size.x,
            z: size.z,
        }
    }
}