Skip to main content

GenerateOptions

Struct GenerateOptions 

Source
#[non_exhaustive]
pub struct GenerateOptions { pub range: Option<[i32; 4]>, pub base: Option<NavMeshSet>, pub skip_existing: bool, pub checkpoint: Option<(usize, PathBuf)>, pub record: Option<PathBuf>, pub threads: Option<usize>, pub connections: Option<usize>, pub seed: Option<[f32; 3]>, pub island_filter: bool, pub build: BuildOptions, pub retry: RetryPolicy, /* private fields */ }
Expand description

Options of generate.

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.
§range: Option<[i32; 4]>

The tile range [x0, z0, x1, z1] (inclusive, clamped, see plan_tiles); None: the whole world, or for a capture the bounding box of its tiles.

§base: Option<NavMeshSet>

A mesh to continue from: its grid, tile size and origin are kept and new tiles replace the tiles of their cell.

§skip_existing: bool

Leave out the tiles that base already has (needs base).

§checkpoint: Option<(usize, PathBuf)>

Every N finished tiles (built, empty and failed) write the mesh atomically to the path. A failing checkpoint stops fetching; the run still returns Ok with GenerateReport::stopped set. N below 1 means 1.

§record: Option<PathBuf>

Write a capture of the fetched tiles to this path. Tiles are recorded by the assembler in plan order, so the capture is deterministic, and a crash loses the tiles that were fetched but not yet applied. Queued tile inputs can be large (a frame may be up to 1 GiB) and there is no aggregate byte budget: the memory of a run grows with the largest tiles in flight.

§threads: Option<usize>

The number of builder threads, at most MAX_WORKERS; None: the cores minus one, at least 1.

§connections: Option<usize>

The number of connections (fetcher threads), at most MAX_WORKERS; None: one per host (1 for a capture).

§seed: Option<[f32; 3]>

The island filter seed; None: the world’s seedPosition.

§island_filter: bool

Run the island filter when the world asks for it (filterIsolatedIslands). On by default.

§build: BuildOptions

Options of the tile build.

§retry: RetryPolicy

Connect and retry rules of the data server client.

Trait Implementations§

Source§

impl Clone for GenerateOptions

Source§

fn clone(&self) -> GenerateOptions

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 GenerateOptions

Source§

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

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

impl Default for GenerateOptions

Source§

fn default() -> Self

Returns the “default value” for a type. 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.