Skip to main content

WorldBlock

Struct WorldBlock 

Source
#[non_exhaustive]
pub struct WorldBlock {
Show 21 fields pub world_size_x: f32, pub world_size_z: f32, pub tile_width: f32, pub tile_height: f32, pub tiles_x: i32, pub tiles_z: i32, pub deep_sea_height: f32, pub deep_water_depth: f32, pub contour_max_error: f32, pub obstacles: bool, pub block_size: i32, pub filter_isolated_islands: bool, pub seed_position: [f32; 3], pub stand_height: f32, pub crouch_height: f32, pub prone_height: f32, pub diameter: f32, pub max_step_height: f32, pub max_slope: f32, pub obstacles_raw: [u8; 4], pub filter_raw: [u8; 4],
}
Expand description

The 84-byte world block of the world params message (spec 3.4).

obstacles and filter_isolated_islands are one byte plus three pad bytes on the wire. The raw four bytes are kept in obstacles_raw and filter_raw so that parsing and encoding round-trips. Parsing sets the bool to raw[0] != 0. Encoding writes the raw bytes, but when the bool disagrees with raw[0] (a value built from Default with only the bool set), byte 0 is replaced by u8::from(bool).

Equality follows the wire: two blocks are equal when every other field is equal and their effective flag bytes (the raw bytes with byte 0 forced to agree with the bool) are equal. So a block built from Default with only obstacles = true set equals the block parsed from its own encoding.

Fields (Non-exhaustive)§

This struct is marked as 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.
§world_size_x: f32

World size in x, metres.

§world_size_z: f32

World size in z, metres.

§tile_width: f32

Tile width, metres.

§tile_height: f32

Tile height (extent in z), metres.

§tiles_x: i32

Number of tiles in x.

§tiles_z: i32

Number of tiles in z.

§deep_sea_height: f32

Top of the sea box (a live tide value), metres.

§deep_water_depth: f32

Water deeper than this becomes deep water, metres.

§contour_max_error: f32

Contour simplification error, metres.

§obstacles: bool

Extract tree parts as cylinder obstacles.

§block_size: i32

Scheduler block edge length in tiles.

§filter_isolated_islands: bool

Run the island filter.

§seed_position: [f32; 3]

Seed position of the island filter.

§stand_height: f32

Agent stand height, metres.

§crouch_height: f32

Agent crouch height, metres.

§prone_height: f32

Agent prone height, metres.

§diameter: f32

Agent diameter, metres.

§max_step_height: f32

Agent maximum step height, metres.

§max_slope: f32

Agent maximum slope, degrees.

§obstacles_raw: [u8; 4]

The four wire bytes of obstacles (flag plus pad), kept for round-tripping.

§filter_raw: [u8; 4]

The four wire bytes of filter_isolated_islands (flag plus pad), kept for round-tripping.

Trait Implementations§

Source§

impl Clone for WorldBlock

Source§

fn clone(&self) -> WorldBlock

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for WorldBlock

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for WorldBlock

Source§

fn default() -> WorldBlock

Returns the “default value” for a type. Read more
Source§

impl PartialEq for WorldBlock

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
§

impl<T> Pointable for T

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<R, P> ReadPrimitive<R> for P
where R: Read + ReadEndian<P>, P: Default,

Source§

fn read_from_little_endian(read: &mut R) -> Result<Self, Error>

Read this value from the supplied reader. Same as ReadEndian::read_from_little_endian().
Source§

fn read_from_big_endian(read: &mut R) -> Result<Self, Error>

Read this value from the supplied reader. Same as ReadEndian::read_from_big_endian().
Source§

fn read_from_native_endian(read: &mut R) -> Result<Self, Error>

Read this value from the supplied reader. Same as ReadEndian::read_from_native_endian().
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.