Skip to main content

NavMeshSet

Struct NavMeshSet 

Source
#[non_exhaustive]
pub struct NavMeshSet { pub version: i32, pub tiles_x: i32, pub tiles_z: i32, pub params: NavMeshParams, pub tiles: Vec<SetTile>, }
Expand description

A .nm file: the mesh parameters and the tile records in file order.

Reading is sequential, as the game does it: the offset table is skipped (its size comes from maxTiles) and its entries are not used, and numTiles records follow back to back. Writing always produces version SET_VERSION and recomputes the offset table.

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.
§version: i32

The set version read from the file (7 or 9). Writing ignores this field and always writes SET_VERSION.

§tiles_x: i32

Grid width in tiles.

§tiles_z: i32

Grid depth in tiles.

§params: NavMeshParams

The mesh parameters.

§tiles: Vec<SetTile>

The tile records, in file order.

Implementations§

Source§

impl NavMeshSet

Source

pub fn read(r: &mut impl Read) -> Result<Self>

Reads a set file. Rejects a bad magic, a version other than 7 or 9, numTiles > maxTiles, negative counts, a record with tileRef == 0 or dataSize <= 0, a record running past the end of the input, and any tile blob that TileData::parse rejects (spec 9.4).

The input is consumed up to the end of the last record; nothing is allocated from a length field before the input has delivered that many bytes.

§Errors

Returns an error for any of the rejections above, or when the reader fails.

Source

pub fn write(&self, w: &mut impl Write) -> Result<()>

Writes the file: version SET_VERSION, the offset table of spec 9.1 (offsets relative to the first record, 0xFFFFFFFF for empty slots) and the records in tiles order.

§Errors

Returns an error, before writing anything, for a negative maxTiles, more tiles than maxTiles, a tile_ref of 0, a tile whose slot is >= maxTiles or used twice, or offsets above 0xFFFFFFFE; or when the writer fails.

Source

pub fn write_atomic(&self, path: &Path) -> Result<()>

Writes the file atomically (spec 9.6, ruling 11): into a uniquely named temporary file in the target’s directory, then sync_all, then a rename over path. An interrupted or failed write leaves the previous file untouched and removes the temporary file.

§Errors

Returns an error when NavMeshSet::write fails or the file cannot be created, synced or renamed.

Trait Implementations§

Source§

impl Clone for NavMeshSet

Source§

fn clone(&self) -> NavMeshSet

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 NavMeshSet

Source§

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

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

impl Default for NavMeshSet

Source§

fn default() -> NavMeshSet

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

impl PartialEq for NavMeshSet

Source§

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

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

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for NavMeshSet

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.