Skip to main content

RuntimeConfig

Struct RuntimeConfig 

Source
pub struct RuntimeConfig {
Show 20 fields pub max_players: u32, pub view_distance: u8, pub simulation_distance: u8, pub max_chained_neighbor_updates: i32, pub online_mode: bool, pub auth_server: Option<String>, pub profile_server: Option<String>, pub encryption: bool, pub allow_flight: bool, pub motd: String, pub use_favicon: bool, pub favicon: String, pub enforce_secure_chat: bool, pub chat_spam_threshold_seconds: i32, pub command_spam_threshold_seconds: i32, pub compression: Option<CompressionInfo>, pub server_links: Option<ServerLinks>, pub packet_workers: Option<usize>, pub chunk_generation_threads: Option<usize>, pub chunk_encoding_threads: Option<usize>,
}
Expand description

Runtime server configuration — the subset of settings needed after startup.

Stored on Server and accessed by game logic at runtime.

Fields§

§max_players: u32

The maximum number of players that can be on the server at once.

§view_distance: u8

The view distance of the server.

§simulation_distance: u8

The simulation distance of the server.

§max_chained_neighbor_updates: i32

Maximum queued neighbor-update tasks in one chained run; negative means unlimited.

§online_mode: bool

Whether the server is in online mode.

§auth_server: Option<String>

Optional authentication endpoint for online-mode hasJoined checks.

§profile_server: Option<String>

Optional endpoint for online-mode player name-to-profile lookups.

§encryption: bool

Whether the server should use encryption. Required in online mode.

§allow_flight: bool

Whether vanilla floating/flying movement checks permit unauthorized flight.

§motd: String

The message of the day.

§use_favicon: bool

Whether to use a favicon.

§favicon: String

The path to the favicon.

§enforce_secure_chat: bool

Whether to enforce secure chat.

§chat_spam_threshold_seconds: i32

Vanilla chat spam threshold window in seconds

§command_spam_threshold_seconds: i32

Vanilla command spam threshold window in seconds

§compression: Option<CompressionInfo>

The compression settings for the server.

§server_links: Option<ServerLinks>

All settings and configurations for server links.

§packet_workers: Option<usize>

Optional count of persistent inter-tick gameplay packet workers.

§chunk_generation_threads: Option<usize>

Optional worker count for the Rayon chunk generation pool.

§chunk_encoding_threads: Option<usize>

Optional worker count for the Rayon chunk encoding pool.

Implementations§

Source§

impl RuntimeConfig

Builds the CServerLinks packet from config, if server links are enabled.

Trait Implementations§

Source§

impl Clone for RuntimeConfig

Source§

fn clone(&self) -> RuntimeConfig

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 RuntimeConfig

Source§

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

Formats the value using the given formatter. 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
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.

§

impl<T> Instrument for T

§

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

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

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> IntoShared for T

Source§

fn into_shared(self) -> Arc<Mutex<RawMutex, Self>>

Wraps this value in an Arc<SyncMutex<>>
§

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> PolicyExt for T
where T: ?Sized,

§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] only if self and other return Action::Follow. Read more
§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] if either self or other returns Action::Follow. Read more
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.
§

impl<T> WithSubscriber for T

§

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
§

fn with_current_subscriber(self) -> WithDispatch<Self>

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