Struct valence::prelude::Client

pub struct Client { /* private fields */ }

The main client component. Contains the underlying network connection and packet buffer.

The component is removed when the client is disconnected. You are allowed to remove the component yourself.

Implementations

impl Client

pub fn connection(&self) -> &(dyn ClientConnection + 'static)

pub fn connection_mut(&mut self) -> &mut (dyn ClientConnection + 'static)

pub fn flush_packets(&mut self) -> Result<(), Error>

Flushes the packet queue to the underlying connection.

This is called automatically at the end of the tick and when the client is dropped. Unless you’re in a hurry, there’s usually no reason to call this method yourself.

Returns an error if flushing was unsuccessful.

pub fn kill<'a, M>(&mut self, message: M)

where M: IntoText<'a>,

Kills the client and shows message on the death screen. If an entity killed the player, you should supply it as killer.

pub fn win_game(&mut self, show_credits: bool)

Respawns client. Optionally can roll the credits before respawning.

pub fn play_particle<P, O>( &mut self, particle: &Particle, long_distance: bool, position: P, offset: O, max_speed: f32, count: i32, )

where P: Into<DVec3>, O: Into<Vec3>,

Puts a particle effect at the given position, only for this client.

pub fn play_sound<P>( &mut self, sound: Sound, category: SoundCategory, position: P, volume: f32, pitch: f32, )

where P: Into<DVec3>,

Plays a sound effect at the given position, only for this client.

pub fn set_velocity<V>(&mut self, velocity: V)

where V: Into<Vec3>,

velocity is in m/s.

pub fn trigger_status(&mut self, status: EntityStatus)

Triggers an EntityStatus.

The status is only visible to this client.

impl Client

pub fn send_custom_payload(&mut self, channel: Ident<&str>, data: &[u8])

impl Client

pub fn set_resource_pack( &mut self, url: &str, hash: &str, forced: bool, prompt_message: Option<Text>, )

Requests that the client download and enable a resource pack.

Arguments

• url - The URL of the resource pack file.
• hash - The SHA-1 hash of the resource pack file. The value must be a 40-character hexadecimal string.
• forced - Whether a client should be kicked from the server upon declining the pack (this is enforced client-side)
• prompt_message - A message to be displayed with the resource pack dialog.

Trait Implementations

impl Component for Client

where Client: Send + Sync + 'static,

const STORAGE_TYPE: StorageType = bevy_ecs::component::StorageType::Table

A constant indicating the storage type used for this component.

fn register_component_hooks(_hooks: &mut ComponentHooks)

Called when registering this component, allowing mutable access to its ComponentHooks.

impl Drop for Client

fn drop(&mut self)

Executes the destructor for this type.

impl WritePacket for Client

Writes packets into this client’s packet buffer. The buffer is flushed at the end of the tick.

fn write_packet_fallible<P>(&mut self, packet: &P) -> Result<(), Error>

where P: Packet + Encode,

Writes a packet to this object. The result of encoding the packet is returned.

fn write_packet_bytes(&mut self, bytes: &[u8])

Copies raw packet data directly into this object. Don’t use this unless you know what you’re doing.

fn write_packet<P>(&mut self, packet: &P)

where P: Packet + Encode,

Writes a packet to this object. Encoding errors are typically logged and discarded.