Struct BiomeSearch 

#[non_exhaustive]
pub struct BiomeSearch {
    pub origin: [i32; 3],
    pub radius: i32,
    pub horizontal_step: i32,
    pub vertical_step: i32,
}

Sampling parameters for LevelRef::find_closest_biome, in blocks.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

origin: [i32; 3]

Centre of the sampled spiral, in block coordinates.

radius: i32

Maximum horizontal search radius in blocks.

horizontal_step: i32

Distance between sampled columns in blocks.

vertical_step: i32

Distance between sampled heights in blocks.

Implementations

impl BiomeSearch

pub const MAX_SAMPLES: u64 = 65_536

Maximum potential biome samples in one synchronous search (65,536). Work is bounded before searching, even when the origin would match immediately.

pub fn new( origin: [i32; 3], radius: i32, horizontal_step: i32, vertical_step: i32, ) -> BiomeSearch

The radius must be nonnegative and both sampling steps positive. A search returns None if (2 * (radius / horizontal_step) + 1)^2 times ((dimension_height - 1) / vertical_step + 1) exceeds Self::MAX_SAMPLES.

Trait Implementations

impl Clone for BiomeSearch

fn clone(&self) -> BiomeSearch

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Copy for BiomeSearch

impl Debug for BiomeSearch

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl Eq for BiomeSearch

impl PartialEq for BiomeSearch

fn eq(&self, other: &BiomeSearch) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for BiomeSearch

impl Wire for BiomeSearch

const MIN: usize

Minimum encoded size, used to reject impossible collection lengths.

fn put(&self, out: &mut Writer)

Encodes this value, recording failures on the writer.

fn put_owned(self, out: &mut Writer)

Consumes owned data when a resource’s ownership must cross the boundary.

fn take(input: &mut Reader<'_>) -> Result<BiomeSearch, WireError>

Decodes one value, leaving any following bytes for the caller.