Enum Event

#[non_exhaustive]
pub enum Event {
    Init,
    Login,
    Spawn,
    Chat(ChatPacket),
    Tick,
    Packet(Arc<ClientboundGamePacket>),
    AddPlayer(PlayerInfo),
    RemovePlayer(PlayerInfo),
    UpdatePlayer(PlayerInfo),
    Death(Option<Arc<ClientboundPlayerCombatKill>>),
    KeepAlive(u64),
    Disconnect(Option<FormattedText>),
}

Something that happened in-game, such as a tick passing or chat message being sent.

Note: Events are sent before they’re processed, so for example game ticks happen at the beginning of a tick before anything has happened.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Init

Happens right after the bot switches into the Game state, but before it’s actually spawned. This can be useful for setting the client information with Client::set_client_information, so the packet doesn’t have to be sent twice.

You may want to use Event::Spawn instead to wait for the bot to be in the world.

Login

Fired when we receive a login packet, which is after Event::Init but before Event::Spawn. You usually want Event::Spawn instead.

Your position may be Vec3::ZERO immediately after you receive this event, but it’ll be ready by the time you get Event::Spawn.

Spawn

Fired when the player fully spawns into the world and is ready to interact with it.

This is usually the event you should listen for when waiting for the bot to be ready.

Chat(ChatPacket)

A chat message was sent in the game chat.

Tick

Happens 20 times per second, but only when the world is loaded.

Packet(Arc<ClientboundGamePacket>)

We received a packet from the server.

Event::Packet(packet) => match *packet {
    ClientboundGamePacket::Login(_) => {
        println!("login packet");
    }
    _ => {}
},

AddPlayer(PlayerInfo)

A player joined the game (or more specifically, was added to the tab list).

RemovePlayer(PlayerInfo)

A player left the game (or maybe is still in the game and was just removed from the tab list).

UpdatePlayer(PlayerInfo)

A player was updated in the tab list (gamemode, display name, or latency changed).

Death(Option<Arc<ClientboundPlayerCombatKill>>)

The client player died in-game.

KeepAlive(u64)

A KeepAlive packet was sent by the server.

Disconnect(Option<FormattedText>)

The client disconnected from the server.

Trait Implementations

impl Clone for Event

fn clone(&self) -> Event

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Event

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.