Struct naia_client::Client

pub struct Client<P: ProtocolType, E: Copy + Eq + Hash> { /* 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<P: ProtocolType, E: Copy + Eq + Hash> Client<P, E>

pub fn new(client_config: ClientConfig, shared_config: SharedConfig<P>) -> Self

Create a new Client

pub fn connect(&mut self, server_address: SocketAddr)

Connect to the given server address

pub fn auth<R: ReplicateSafe<P>>(&mut self, auth: R)

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

pub fn send_message<R: ReplicateSafe<P>>(
    &mut self,
    message: &R,
    guaranteed_delivery: bool
)

Queues up an Message to be sent to the Server

pub fn send_command<R: ReplicateSafe<P>>(
    &mut self,
    predicted_entity: &E,
    command: R
)

Queues up a Command for an assigned Entity to be sent to the Server

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

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

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

Return a list of all Entities

pub fn server_address(&self) -> SocketAddr

Get the address currently associated with the Server

pub fn connected(&self) -> bool

Return whether or not a connection has been established 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<u16>

Gets the current tick of the Client

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

Gets the last received tick from the Server

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

Gets the interpolation tween amount for the current frame

pub fn receive<W: WorldMutType<P, E>>(
    &mut self,
    world: W
) -> VecDeque<Result<Event<P, E>, NaiaClientError>>

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