From 13d5cbed1fed1695c28dc1bf1c11b24c68819970 Mon Sep 17 00:00:00 2001
From: mat <git@matdoes.dev>
Date: Thu, 20 Mar 2025 01:49:15 +0000
Subject: document Position default

---
 azalea-client/src/client.rs | 4 ++++
 1 file changed, 4 insertions(+)

(limited to 'azalea-client/src/client.rs')

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>())
     }
-- 
cgit v1.2.3