Struct naia_client::NaiaClient

pub struct NaiaClient<T: EventType, U: EntityType> { /* fields omitted */ }

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

Implementations

impl<T: EventType, U: EntityType> NaiaClient<T, U>

pub fn new(
    server_address: SocketAddr,
    manifest: Manifest<T, U>,
    config: Option<Config>,
    auth: Option<T>
) -> Self

Create a new client, given the server's address, a shared manifest, an optional Config, and an optional Authentication event

pub fn receive(&mut self) -> Result<ClientEvent<T>, NaiaClientError>

Must be called regularly, performs updates to the connection, and retrieves event/entity updates sent by the Server

pub fn send_event(&mut self, event: &impl Event<T>)

Queues up an Event to be sent to the Server

pub fn server_address(&self) -> SocketAddr

Get the address currently associated with the Server

pub fn get_entity(&self, key: LocalEntityKey) -> Option<&U>

Get a reference to an Entity currently in scope for the Client, given that Entity's Key

pub fn get_rtt(&self) -> f32

Get the current measured Round Trip Time to the Server

Trait Implementations

impl<T: Debug + EventType, U: Debug + EntityType> Debug for NaiaClient<T, U>

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

Formats the value using the given formatter.