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 8 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 preload(self, preload: bool) -> Self

Configure whether or not should the world preload chunks. Default is false.

source

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

Configure the preload radius of the world. Default is 12 chunks.

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 1000 voxel updates.

source

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

source

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

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 time_per_day(self, time_per_day: u64) -> Self

Configure the amount of ticks per day. Default is 24000 ticks.

source

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

Configure the water level of the voxelize world.

source

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

Configure the seed of the world. Default is 123123123.

source

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

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

source

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

Configure the collision repulsion between entities. Defaults to 0.3.

source

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

Configure the repulsion factor when a collision is detected between clients and entities.

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 command_symbol(self, command_symbol: &str) -> Self

Configure the prefix of command messages.

source

pub fn build(self) -> WorldConfig

Create a world configuration.

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
source§

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

source§

fn into_any(self: Box<T>) -> Box<dyn Any>

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.
source§

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

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

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.
source§

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.
source§

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

source§

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

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

impl<T> From<T> for T

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<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
source§

impl<T> Pointable for T

source§

const ALIGN: usize = _

The alignment of pointer.
§

type Init = T

The type for initializers.
source§

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

Initializes a with the given initializer. Read more
source§

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

Dereferences the given pointer. Read more
source§

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

Mutably dereferences the given pointer. Read more
source§

unsafe fn drop(ptr: usize)

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

impl<T> Same for T

§

type Output = T

Should always be Self
source§

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

source§

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

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

fn is_in_subset(&self) -> bool

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

fn to_subset_unchecked(&self) -> SS

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

fn from_subset(element: &SS) -> SP

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

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

§

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>,

§

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.
source§

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

source§

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
source§

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

source§

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