Struct ServerSettings 

pub struct ServerSettings {
    pub tick_rate: NonZero<u32>,
    pub compression_threshold: CompressionThreshold,
}

Fields

tick_rate: NonZero<u32>

The target ticks per second (TPS) of the server. This is the number of game updates that should occur in one second.

On each game update (tick), the server is expected to update game logic and respond to packets from clients. Once this is complete, the server will sleep for any remaining time until a full tick duration has passed.

Note that the official Minecraft client only processes packets at 20hz, so there is little benefit to a tick rate higher than the default 20.

Default Value

DEFAULT_TPS

compression_threshold: CompressionThreshold

The compression threshold to use for compressing packets. For a compression threshold of Some(N), packets with encoded lengths >= N are compressed while all others are not. None disables compression completely.

If the server is used behind a proxy on the same machine, you will likely want to disable compression.

Default Value

Compression is enabled with an unspecified value. This value may change in future versions.

Trait Implementations

impl Clone for ServerSettings

fn clone(&self) -> ServerSettings

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Component for ServerSettings

where ServerSettings: Send + Sync + 'static,

const STORAGE_TYPE: StorageType = bevy_ecs::component::StorageType::SparseSet

A constant indicating the storage type used for this component.

type Mutability = Mutable

A marker type to assist Bevy with determining if this component is mutable, or immutable. Mutable components will have [Component<Mutability = Mutable>], while immutable components will instead have [Component<Mutability = Immutable>].

fn register_required_components( _requiree: ComponentId, required_components: &mut RequiredComponentsRegistrator<'_, '_>, )

Registers required components.

fn clone_behavior() -> ComponentCloneBehavior

Called when registering this component, allowing to override clone function (or disable cloning altogether) for this component.

fn relationship_accessor() -> Option<ComponentRelationshipAccessor<ServerSettings>>

Returns [ComponentRelationshipAccessor] required for working with relationships in dynamic contexts.

fn on_add() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_add [ComponentHook] for this [Component] if one is defined.

fn on_insert() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_insert [ComponentHook] for this [Component] if one is defined.

fn on_discard() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_discard [ComponentHook] for this [Component] if one is defined.

fn on_remove() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_remove [ComponentHook] for this [Component] if one is defined.

fn on_despawn() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_despawn [ComponentHook] for this [Component] if one is defined.

fn map_entities<E>(_this: &mut Self, _mapper: &mut E)

where E: EntityMapper,

Maps the entities on this component using the given [EntityMapper]. This is used to remap entities in contexts like scenes and entity cloning. When deriving [Component], this is populated by annotating fields containing entities with #[entities]

impl Default for ServerSettings

fn default() -> ServerSettings

Returns the “default value” for a type.

impl Resource for ServerSettings

where ServerSettings: Send + Sync + 'static,