Struct voxelize::WorldConfigBuilder

source · [−]

pub struct WorldConfigBuilder { /* private fields */ }

Expand description

Builder for a world configuration.

Implementations

source

impl WorldConfigBuilder

source

pub fn new() -> Self

Create a new WorldConfigBuilder with default values.

source

pub fn max_clients(self, max_clients: usize) -> Self

Configure the maximum clients allowed for this world. Defaults is 100 clients.

source

pub fn chunk_size(self, chunk_size: usize) -> Self

Configure the horizontal dimension of chunks in this world. Default is 16 blocks wide.

source

pub fn sub_chunks(self, sub_chunks: usize) -> Self

Configure the number of sub chunks a chunk is divided into. Default is 16 sub-chunks.

source

pub fn min_chunk(self, min_chunk: [i32 ; 2]) -> Self

Configure the minimum inclusive chunk of the world. Default is [i32::MIN, i32::MIN].

source

pub fn max_chunk(self, max_chunk: [i32 ; 2]) -> Self

Configure the maximum inclusive chunk of the world. Default is [i32::MAX, i32::MAX].

source

pub fn max_height(self, max_height: usize) -> Self

Configure the maximum height of the world. Default is 256 blocks high.

source

pub fn max_light_level(self, max_light_level: u32) -> Self

Configure the maximum light level that propagates the world. Default is 15 blocks.

source

pub fn max_chunks_per_tick(self, max_chunks_per_tick: usize) -> Self

Configure the maximum amount of chunks to be processed per tick. Default is 24 chunks.

source

pub fn max_updates_per_tick(self, max_updates_per_tick: usize) -> Self

Configure the maximum amount of voxel updates to be processed per tick. Default is 500 voxel updates.

source

pub fn max_response_per_tick(self, max_response_per_tick: usize) -> Self

Configure the maximum amount of chunks to be sent to the client per tick. Default is 3 chunks.

source

pub fn max_saves_per_tick(self, max_saves_per_tick: usize) -> Self

Configure the maximum amount of chunks to be saved.

source

pub fn water_level(self, water_level: usize) -> Self

Configure the water level of the voxelize world.

source

pub fn preload_radius(self, preload_radius: u32) -> Self

Configure the radius around 0,0 for the world to preload chunks in. Default is 8 chunks.

source

pub fn seed(self, seed: u32) -> Self

Configure the seed of the world. Default is 123123123.

source

pub fn terrain(self, terrain: &NoiseParams) -> Self

Configure the terrain of the world. Default, check out NoiseParams.

source

pub fn collision_repulsion(self, collision_repulsion: f32) -> Self

Configure the collision repulsion between entities. Defaults to 0.3.

source

pub fn saving(self, saving: bool) -> Self

Configure whether or not this world should have the chunk data saved.

source

pub fn save_dir(self, save_dir: &str) -> Self

Configure the directory to save the world.

source

pub fn save_interval(self, save_interval: usize) -> Self

Configure the saving interval of the world.

source

pub fn build(self) -> WorldConfig

Create a world configuration.

Auto Trait Implementations

impl RefUnwindSafe for WorldConfigBuilder

impl Send for WorldConfigBuilder

impl Sync for WorldConfigBuilder

impl Unpin for WorldConfigBuilder

impl UnwindSafe for WorldConfigBuilder

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

impl<T> Any for T where
T: Any,

fn get_type_id(&self) -> TypeId

source

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

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

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

const: unstable · source

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

Mutably borrows from an owned value. Read more

impl<T> Downcast for T where
T: Any,

fn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, Global>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait. Read more

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait. Read more

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s. Read more

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s. Read more

impl<T> DowncastSync for T where
T: Any + Send + Sync,

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Send + Sync + 'static>

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait. Read more

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

impl<T> Instrument for T

source

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

source

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

source

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

const: unstable · 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.

impl<T> Pointable for T

const ALIGN: usize = mem::align_of::<T>()

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

source

impl<T> Same<T> for T

type Output = T

Should always be Self

impl<SS, SP> SupersetOf<SS> for SP where
SS: SubsetOf<SP>,

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.

source

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

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

source

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

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

impl<V, T> VZip<V> for T where
V: MultiLane<T>,

fn vzip(self) -> V

source

impl<T> WithSubscriber for T

source

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

source

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more

Struct voxelize::WorldConfigBuilder

Implementations

impl WorldConfigBuilder

pub fn new() -> Self

pub fn max_clients(self, max_clients: usize) -> Self

pub fn chunk_size(self, chunk_size: usize) -> Self

pub fn sub_chunks(self, sub_chunks: usize) -> Self

pub fn min_chunk(self, min_chunk: [i32; 2]) -> Self

pub fn max_chunk(self, max_chunk: [i32; 2]) -> Self

pub fn max_height(self, max_height: usize) -> Self

pub fn max_light_level(self, max_light_level: u32) -> Self

pub fn max_chunks_per_tick(self, max_chunks_per_tick: usize) -> Self

pub fn max_updates_per_tick(self, max_updates_per_tick: usize) -> Self

pub fn max_response_per_tick(self, max_response_per_tick: usize) -> Self

pub fn max_saves_per_tick(self, max_saves_per_tick: usize) -> Self

pub fn water_level(self, water_level: usize) -> Self

pub fn preload_radius(self, preload_radius: u32) -> Self

pub fn seed(self, seed: u32) -> Self

pub fn terrain(self, terrain: &NoiseParams) -> Self

pub fn collision_repulsion(self, collision_repulsion: f32) -> Self

pub fn saving(self, saving: bool) -> Self

pub fn save_dir(self, save_dir: &str) -> Self

pub fn save_interval(self, save_interval: usize) -> Self

pub fn build(self) -> WorldConfig

Auto Trait Implementations

impl RefUnwindSafe for WorldConfigBuilder

impl Send for WorldConfigBuilder

impl Sync for WorldConfigBuilder

impl Unpin for WorldConfigBuilder

impl UnwindSafe for WorldConfigBuilder

Blanket Implementations

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

fn type_id(&self) -> TypeId

impl<T> Any for T where T: Any,

fn get_type_id(&self) -> TypeId

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

fn borrow(&self) -> &T

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

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

impl<T> Downcast for T where T: Any,

fn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, Global>

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>

fn as_any(&self) -> &(dyn Any + 'static)

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

impl<T> DowncastSync for T where T: Any + Send + Sync,

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Send + Sync + 'static>

impl<T> From<T> for T

fn from(t: T) -> T

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

fn in_current_span(self) -> Instrumented<Self>

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

fn into(self) -> U

impl<T> Pointable for T

const ALIGN: usize = mem::align_of::<T>()

type Init = T

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

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

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

unsafe fn drop(ptr: usize)

impl<T> Same<T> for T

type Output = T

impl<SS, SP> SupersetOf<SS> for SP where SS: SubsetOf<SP>,

fn to_subset(&self) -> Option<SS>

fn is_in_subset(&self) -> bool

fn to_subset_unchecked(&self) -> SS

fn from_subset(element: &SS) -> SP

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

type Error = Infallible

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

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

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

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

impl<V, T> VZip<V> for T where V: MultiLane<T>,

fn vzip(self) -> V

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where S: Into<Dispatch>,

fn with_current_subscriber(self) -> WithDispatch<Self>

impl<T> Event for T where T: 'static + Send + Sync,

impl<T> Resource for T where T: Any + Send + Sync,

pub fn min_chunk(self, min_chunk: [i32 ; 2]) -> Self

pub fn max_chunk(self, max_chunk: [i32 ; 2]) -> Self

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

impl<T> Any for T where
T: Any,

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

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

impl<T> Downcast for T where
T: Any,

impl<T> DowncastSync for T where
T: Any + Send + Sync,

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

impl<SS, SP> SupersetOf<SS> for SP where
SS: SubsetOf<SP>,

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

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

impl<V, T> VZip<V> for T where
V: MultiLane<T>,

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,

impl<T> Event for T where
T: 'static + Send + Sync,

impl<T> Resource for T where
T: Any + Send + Sync,