Struct naia_client::Client

pub struct Client<E: Copy + Eq + Hash + Send + Sync> { /* private fields */ }

Client can send/receive messages to/from a server, and has a pool of in-scope entities/components that are synced with the server

Implementations

impl<E: Copy + Eq + Hash + Send + Sync> Client<E>

pub fn new<P: Into<Protocol>>(client_config: ClientConfig, protocol: P) -> Self

Create a new Client

pub fn auth<M: Message>(&mut self, auth: M)

Set the auth object to use when setting up a connection with the Server

pub fn connect<S: Into<Box<dyn Socket>>>(&mut self, socket: S)

Connect to the given server address

pub fn is_disconnected(&self) -> bool

Returns whether or not the client is disconnected

pub fn is_connecting(&self) -> bool

Returns whether or not a connection is being established with the Server

pub fn is_connected(&self) -> bool

Returns whether or not a connection has been established with the Server

pub fn disconnect(&mut self)

Disconnect from Server

pub fn socket_config(&self) -> &SocketConfig

Returns socket config

pub fn receive<W: WorldMutType<E>>(&mut self, world: W) -> Events<E>

Must call this regularly (preferably at the beginning of every draw frame), in a loop until it returns None. Retrieves incoming update data from the server, and maintains the connection.

pub fn send_message<C: Channel, M: Message>(&mut self, message: &M)

Queues up an Message to be sent to the Server

pub fn send_tick_buffer_message<C: Channel, M: Message>( &mut self, tick: &Tick, message: &M )

pub fn spawn_entity<W: WorldMutType<E>>( &mut self, world: W ) -> EntityMut<'_, E, W>

Creates a new Entity and returns an EntityMut which can be used for further operations on the Entity

pub fn entity<W: WorldRefType<E>>( &self, world: W, entity: &E ) -> EntityRef<'_, E, W>

Retrieves an EntityRef that exposes read-only operations for the given Entity. Panics if the Entity does not exist.

pub fn entity_mut<W: WorldMutType<E>>( &mut self, world: W, entity: &E ) -> EntityMut<'_, E, W>

Retrieves an EntityMut that exposes read and write operations for the Entity. Panics if the Entity does not exist.

pub fn entities<W: WorldRefType<E>>(&self, world: &W) -> Vec<E>

Return a list of all Entities

pub fn entity_owner(&self, entity: &E) -> EntityOwner

pub fn enable_entity_replication(&mut self, entity: &E)

This is used only for Hecs/Bevy adapter crates, do not use otherwise!

pub fn disable_entity_replication(&mut self, entity: &E)

This is used only for Hecs/Bevy adapter crates, do not use otherwise!

pub fn entity_replication_config(&self, entity: &E) -> Option<ReplicationConfig>

This is used only for Hecs/Bevy adapter crates, do not use otherwise!

pub fn configure_entity_replication<W: WorldMutType<E>>( &mut self, world: &mut W, entity: &E, config: ReplicationConfig )

This is used only for Hecs/Bevy adapter crates, do not use otherwise!

pub fn entity_authority_status(&self, entity: &E) -> Option<EntityAuthStatus>

This is used only for Hecs/Bevy adapter crates, do not use otherwise!

pub fn entity_request_authority(&mut self, entity: &E)

This is used only for Hecs/Bevy adapter crates, do not use otherwise!

pub fn entity_release_authority(&mut self, entity: &E)

This is used only for Hecs/Bevy adapter crates, do not use otherwise!

pub fn server_address(&self) -> Result<SocketAddr, NaiaClientError>

Get the address currently associated with the Server

pub fn rtt(&self) -> f32

Gets the average Round Trip Time measured to the Server

pub fn jitter(&self) -> f32

Gets the average Jitter measured in connection to the Server

pub fn client_tick(&self) -> Option<Tick>

Gets the current tick of the Client

pub fn server_tick(&self) -> Option<Tick>

Gets the current tick of the Server

pub fn client_interpolation(&self) -> Option<f32>

Gets the interpolation tween amount for the current frame, for use by entities on the Client Tick (i.e. predicted)

pub fn server_interpolation(&self) -> Option<f32>

Gets the interpolation tween amount for the current frame, for use by entities on the Server Tick (i.e. authoritative)

pub fn outgoing_bandwidth(&mut self) -> f32

pub fn incoming_bandwidth(&mut self) -> f32

pub fn despawn_entity_worldless(&mut self, entity: &E)

pub fn insert_component_worldless( &mut self, entity: &E, component: &mut dyn Replicate )

pub fn remove_component_worldless( &mut self, entity: &E, component_kind: &ComponentKind )

pub fn add_redundant_remote_entity_to_host( &mut self, world_entity: &E, remote_entity: RemoteEntity )

Trait Implementations

impl<E: Copy + Eq + Hash + Send + Sync> EntityAndGlobalEntityConverter<E> for Client<E>

fn global_entity_to_entity( &self, global_entity: &GlobalEntity ) -> Result<E, EntityDoesNotExistError>

fn entity_to_global_entity( &self, entity: &E ) -> Result<GlobalEntity, EntityDoesNotExistError>