document Position default

1 files changed, 4 insertions, 0 deletions

diff --git a/azalea-client/src/client.rs b/azalea-client/src/client.rs
index 840d373d..05c529b8 100644
--- a/azalea-client/src/client.rs
+++ b/azalea-client/src/client.rs
@@ -683,6 +683,10 @@ impl Client {
     /// Get the position of this client.
     ///
     /// This is a shortcut for `Vec3::from(&bot.component::<Position>())`.
+    ///
+    /// Note that this value is given a default of [`Vec3::ZERO`] when it
+    /// receives the login packet, its true position may be set ticks
+    /// later.
     pub fn position(&self) -> Vec3 {
         Vec3::from(&self.component::<Position>())
     }