aboutsummaryrefslogtreecommitdiff
path: root/azalea-client/src/plugins/events.rs
diff options
context:
space:
mode:
authormat <git@matdoes.dev>2025-10-12 23:01:54 +0300
committermat <git@matdoes.dev>2025-10-12 23:01:54 +0300
commitee2575794e91b9457a74a95daf1dcc707058cd58 (patch)
treedf725850ef18ded5ce3f6552e17095d0f704ae84 /azalea-client/src/plugins/events.rs
parent1a1402954b07cd77615d0afc026c73b008787f51 (diff)
downloadazalea-drasl-ee2575794e91b9457a74a95daf1dcc707058cd58.tar.xz
upgrade deps and clean up lots of doc comments
Diffstat (limited to 'azalea-client/src/plugins/events.rs')
-rw-r--r--azalea-client/src/plugins/events.rs15
1 files changed, 10 insertions, 5 deletions
diff --git a/azalea-client/src/plugins/events.rs b/azalea-client/src/plugins/events.rs
index bc8a7a98..e8d99e7c 100644
--- a/azalea-client/src/plugins/events.rs
+++ b/azalea-client/src/plugins/events.rs
@@ -54,12 +54,16 @@ use crate::{
#[non_exhaustive]
pub enum Event {
/// 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.
+ /// 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.
+ ///
+ /// [`Client::set_client_information`]: crate::Client::set_client_information
Init,
/// Fired when we receive a login packet, which is after [`Event::Init`] but
/// before [`Event::Spawn`]. You usually want [`Event::Spawn`] instead.
@@ -123,8 +127,9 @@ pub enum Event {
}
/// A component that contains an event sender for events that are only
-/// received by local players. The receiver for this is returned by
-/// [`Client::start_client`].
+/// received by local players.
+///
+/// The receiver for this is returned by [`Client::start_client`].
///
/// [`Client::start_client`]: crate::Client::start_client
#[derive(Component, Deref, DerefMut)]