Struct valence::client::Client

pub struct Client<C: Config> {
    pub state: C::ClientState,
    /* private fields */
}

Represents a remote connection to a client after successfully logging in.

Much like an Entity, clients possess a location, rotation, and UUID. However, clients are handled separately from entities and are partially managed by the library.

By default, clients have no influence over the worlds they reside in. They cannot break blocks, hurt entities, or see other clients. Interactions with the server must be handled explicitly with Self::pop_event.

Additionally, clients possess Player entity data which is only visible to themselves. This can be accessed with Self::player and Self::player_mut.

The Difference Between a “Client” and a “Player”

Normally in Minecraft, players and clients are one and the same. Players are simply a subtype of the entity base class backed by a remote connection.

In Valence however, clients and players are decoupled. This separation allows for greater flexibility and enables parallelism.

Fields

state: C::ClientState

Custom state.

Implementations

impl<C: Config> Client<C>

pub fn created_this_tick(&self) -> bool

If the client joined the game this tick.

pub fn uuid(&self) -> Uuid

Gets the client’s UUID.

pub fn username(&self) -> &str

Gets the username of this client.

pub fn textures(&self) -> Option<&SignedPlayerTextures>

Gets the player textures of this client. If the client does not have a skin, then None is returned.

pub fn world(&self) -> WorldId

Gets the world this client is located in.

pub fn player_list(&self) -> Option<&PlayerListId>

Gets the player list this client sees.

pub fn set_player_list(
    &mut self,
    id: impl Into<Option<PlayerListId>>
) -> Option<PlayerListId>

Sets the player list this client sees.

The previous player list ID is returned.

pub fn set_flat(&mut self, flat: bool)

Sets if this client sees the world as superflat. Superflat worlds have a horizon line lower than normal worlds.

The player must be (re)spawned for changes to take effect.

pub fn is_flat(&self) -> bool

Gets if this client sees the world as superflat. Superflat worlds have a horizon line lower than normal worlds.

pub fn spawn(&mut self, world: WorldId)

Changes the world this client is located in and respawns the client. This can be used to respawn the client after death.

The given WorldId must be valid. Otherwise, the client is disconnected.

pub fn send_message(&mut self, msg: impl Into<Text>)

Sends a system message to the player which is visible in the chat. The message is only visible to this client.

pub fn position(&self) -> Vec3<f64>

Gets the absolute position of this client in the world it is located in.

pub fn teleport(&mut self, pos: impl Into<Vec3<f64>>, yaw: f32, pitch: f32)

Changes the position and rotation of this client in the world it is located in.

If you want to change the client’s world, use Self::spawn.

pub fn velocity(&self) -> Vec3<f32>

Gets the most recently set velocity of this client in m/s.

pub fn set_velocity(&mut self, velocity: impl Into<Vec3<f32>>)

Sets the client’s velocity in m/s.

pub fn yaw(&self) -> f32

Gets this client’s yaw.

pub fn pitch(&self) -> f32

Gets this client’s pitch.

pub fn spawn_position(&self) -> BlockPos

Gets the spawn position. The client will see minecraft:compass items point at the returned position.

pub fn set_spawn_position(&mut self, pos: impl Into<BlockPos>, yaw_degrees: f32)

Sets the spawn position. The client will see minecraft:compass items point at the provided position.

pub fn death_location(&self) -> Option<(DimensionId, BlockPos)>

Gets the last death location of this client. The client will see minecraft:recovery_compass items point at the returned position.

If the client’s current dimension differs from the returned dimension or the location is None then the compass will spin randomly.

pub fn set_death_location(&mut self, location: Option<(DimensionId, BlockPos)>)

Sets the last death location. The client will see minecraft:recovery_compass items point at the provided position. If the client’s current dimension differs from the provided dimension or the location is None then the compass will spin randomly.

Changes to the last death location take effect when the client (re)spawns.

pub fn game_mode(&self) -> GameMode

Gets the client’s game mode.

pub fn set_game_mode(&mut self, game_mode: GameMode)

Sets the client’s game mode.

pub fn set_title(
    &mut self,
    title: impl Into<Text>,
    subtitle: impl Into<Text>,
    animation: impl Into<Option<TitleFade>>
)

Sets the title this client sees.

A title is a large piece of text displayed in the center of the screen which may also include a subtitle underneath it. The title can be configured to fade in and out using the TitleFade struct.

pub fn attack_speed(&self) -> f64

Gets the attack cooldown speed.

pub fn set_attack_speed(&mut self, speed: f64)

Sets the attack cooldown speed.

pub fn movement_speed(&self) -> f64

Gets the speed at which the client can run on the ground.

pub fn set_movement_speed(&mut self, speed: f64)

Sets the speed at which the client can run on the ground.

pub fn clear_title(&mut self)

Removes the current title from the client’s screen.

pub fn is_disconnected(&self) -> bool

Gets whether or not the client is connected to the server.

A disconnected client object will never become reconnected. It is your responsibility to remove disconnected clients from the Clients container.

pub fn events(
    &self
) -> impl DoubleEndedIterator<Item = &ClientEvent> + ExactSizeIterator + FusedIterator + Clone + '_

Returns an iterator over all pending client events in the order they will be removed from the queue.

pub fn pop_event(&mut self) -> Option<ClientEvent>

Removes a ClientEvent from the event queue.

If there are no remaining events, None is returned.

Any remaining client events are deleted at the end of the current tick.

pub fn push_entity_event(&mut self, event: EntityEvent)

Pushes an entity event to the queue.

pub fn view_distance(&self) -> u8

The current view distance of this client measured in chunks. The client will not be able to see chunks and entities past this distance.

The result is in 2..=32.

pub fn set_view_distance(&mut self, dist: u8)

Sets the view distance. The client will not be able to see chunks and entities past this distance.

The new view distance is measured in chunks and is clamped to 2..=32.

pub fn set_hardcore(&mut self, hardcore: bool)

Enables hardcore mode. This changes the design of the client’s hearts.

To have any visible effect, this function must be called on the same tick the client joins the server.

pub fn is_hardcore(&self) -> bool

Gets if hardcore mode is enabled.

pub fn settings(&self) -> Option<&Settings>

Gets the client’s current settings.

pub fn disconnect(&mut self, reason: impl Into<Text>)

Disconnects this client from the server with the provided reason. This has no effect if the client is already disconnected.

All future calls to Self::is_disconnected will return true.

pub fn disconnect_no_reason(&mut self)

Like Self::disconnect, but no reason for the disconnect is displayed.

pub fn player(&self) -> &Player

Returns an immutable reference to the client’s own Player data.

pub fn player_mut(&mut self) -> &mut Player

Returns a mutable reference to the client’s own Player data.

Changes made to this data is only visible to this client.

pub fn send_packet(&mut self, packet: impl Into<S2cPlayPacket>)

Attempts to enqueue a play packet to be sent to this client. The client is disconnected if the clientbound packet buffer is full.