Struct GlobalBiomes 

pub struct GlobalBiomes { /* private fields */ }

This is a global biomes palette, it is used in chunk storage to store biomes. It allows you to register individual biomes in it as well as static biomes arrays defined using the macro biomes!.

Implementations

impl GlobalBiomes

pub fn new() -> Self

pub fn with_all(slice: &[&'static Biome]) -> Result<Self, ()>

A simple constructor to directly call register_all with given biomes slice.

pub fn register(&mut self, biome: &'static Biome) -> Result<(), ()>

Register a single biome to this palette, returns Err if no more save ID (SID) is available, Ok is returned if successful, if a biome was already in the palette it also returns Ok.

pub fn register_all(&mut self, slice: &[&'static Biome]) -> Result<(), ()>

An optimized way to call register multiple times for each given biome, the returned follow the same rules as register, if an error happens, it return without and previous added biomes are kept.

pub fn get_sid_from(&self, biome: &'static Biome) -> Option<u16>

pub fn get_biome_from(&self, sid: u16) -> Option<&'static Biome>

pub fn get_biome_from_name(&self, name: &str) -> Option<&'static Biome>

pub fn get_biome_from_id(&self, id: i32) -> Option<&'static Biome>

pub fn has_biome(&self, biome: &'static Biome) -> bool

pub fn check_biome<E>( &self, biome: &'static Biome, err: impl FnOnce() -> E, ) -> Result<&'static Biome, E>

pub fn biomes_count(&self) -> usize