Struct NetworkSettings 

pub struct NetworkSettings {
    pub callbacks: ErasedNetworkCallbacks,
    pub tokio_handle: Option<Handle>,
    pub max_connections: usize,
    pub max_players: usize,
    pub address: SocketAddr,
    pub connection_mode: ConnectionMode,
    pub incoming_byte_limit: usize,
    pub outgoing_byte_limit: usize,
}

Settings for NetworkPlugin. Note that mutations to these fields have no effect after the plugin is built.

Fields

callbacks: ErasedNetworkCallbacks

tokio_handle: Option<Handle>

The [Handle] to the tokio runtime the server will use. If None is provided, the server will create its own tokio runtime at startup.

Default Value

None

max_connections: usize

The maximum number of simultaneous initial connections to the server.

This only considers the connections before the play state where the client is spawned into the world..

Default Value

The default value is left unspecified and may change in future versions.

max_players: usize

Default Value

20

address: SocketAddr

The socket address the server will be bound to.

Default Value

0.0.0.0:25565, which will listen on every available network interface.

connection_mode: ConnectionMode

The connection mode. This determines if client authentication and encryption should take place and if the server should get the player data from a proxy.

NOTE: Mutations to this field have no effect if

Default Value

ConnectionMode::Online

incoming_byte_limit: usize

The maximum capacity (in bytes) of the buffer used to hold incoming packet data.

A larger capacity reduces the chance that a client needs to be disconnected due to a full buffer, but increases potential memory usage.

Default Value

The default value is left unspecified and may change in future versions.

outgoing_byte_limit: usize

The maximum capacity (in bytes) of the buffer used to hold outgoing packet data.

A larger capacity reduces the chance that a client needs to be disconnected due to a full buffer, but increases potential memory usage.

Default Value

The default value is left unspecified and may change in future versions.

Trait Implementations

impl Clone for NetworkSettings

fn clone(&self) -> NetworkSettings

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Component for NetworkSettings

where Self: 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<Self>>

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 NetworkSettings

fn default() -> Self

Returns the “default value” for a type.

impl Resource for NetworkSettings

where Self: Send + Sync + 'static,