Struct voxelize::WorldConfig

source · [−]

pub struct WorldConfig {Show 18 fields
    pub max_clients: usize,
    pub chunk_size: usize,
    pub min_chunk: [i32; 2],
    pub max_chunk: [i32; 2],
    pub max_height: usize,
    pub max_light_level: u32,
    pub max_chunk_per_tick: usize,
    pub max_updates_per_tick: usize,
    pub max_response_per_tick: usize,
    pub preload_radius: u32,
    pub water_level: usize,
    pub gravity: [f32; 3],
    pub min_bounce_impulse: f32,
    pub air_drag: f32,
    pub fluid_drag: f32,
    pub fluid_density: f32,
    pub seed: u32,
    pub terrain: NoiseParams,
}

Expand description

World configuration, storing information of how a world is constructed.

Fields

max_clients: usize

Max clients for each world. Default is 100 clients.

chunk_size: usize

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

min_chunk: [i32; 2]

The minimum inclusive chunk on this world. Default is [i32::MIN, i32::MIN].

max_chunk: [i32; 2]

The maximum inclusive chunk on this world. Default is [i32::MAX, i32::MAX].

max_height: usize

Max height of the world. Default is 256 blocks high.

max_light_level: u32

Max light level that light can propagate. Default is 15 blocks.

max_chunk_per_tick: usize

Maximum chunks to be processed per tick. Default is 24 chunks.

max_updates_per_tick: usize

Maximum voxel updates to be processed per tick. Default is 500 voxels.

max_response_per_tick: usize

Maximum responses to send to client per tick to prevent bottle-necking. Default is 4 chunks.

preload_radius: u32

Radius of chunks around 0,0 to be preloaded. Default is 8 chunks.

water_level: usize

Water level of the voxelize world.

gravity: [f32; 3]

Gravity of the voxelize world.

min_bounce_impulse: f32

Minimum impulse to start bouncing.

air_drag: f32

Drag of the air in the voxelize world.

fluid_drag: f32

Drag of the fluid in the voxelize world.

fluid_density: f32

Fluid density of the voxelize world. TODO: move this to registry.

seed: u32

Seed of the world. Default is “Voxelize”.

terrain: NoiseParams

Terrain parameters

Implementations

source

impl WorldConfig

source

pub fn new() -> WorldConfigBuilder

Create a new world config using the Builder pattern.

Example

let config = WorldConfig::new().chunk_size(8).max_height(64).build();
server.create_world("small-world", &config);

source

pub fn get_init_config(&self) -> InitConfig

Get the INIT configurations

Trait Implementations

source

impl Clone for WorldConfig

source

fn clone(&self) -> WorldConfig

Returns a copy of the value. Read more

1.0.0 · source

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

Performs copy-assignment from source. Read more

source

impl Default for WorldConfig

source

fn default() -> WorldConfig

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

Auto Trait Implementations

impl RefUnwindSafe for WorldConfig

impl Send for WorldConfig

impl Sync for WorldConfig

impl Unpin for WorldConfig

impl UnwindSafe for WorldConfig

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

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::()

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

source

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

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> TryDefault for T where
T: Default,

source

fn try_default() -> Result<T, String>

Tries to create the default.

source

fn unwrap_default() -> Self

Calls try_default and panics on an error case.

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::WorldConfig

Fields

Implementations

impl WorldConfig

pub fn new() -> WorldConfigBuilder

pub fn get_init_config(&self) -> InitConfig

Trait Implementations

impl Clone for WorldConfig

fn clone(&self) -> WorldConfig

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

impl Default for WorldConfig

fn default() -> WorldConfig

Auto Trait Implementations

impl RefUnwindSafe for WorldConfig

impl Send for WorldConfig

impl Sync for WorldConfig

impl Unpin for WorldConfig

impl UnwindSafe for WorldConfig

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> 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::()

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<T> ToOwned for T where T: Clone,

type Owned = T

fn to_owned(&self) -> T

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

impl<T> TryDefault for T where T: Default,

fn try_default() -> Result<T, String>

fn unwrap_default() -> Self

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,

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, U> Into<U> for T where
U: From<T>,

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

impl<T> TryDefault for T where
T: Default,

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,