From 6b0e1e9b67c43eccfc11949374b4747fe5658d17 Mon Sep 17 00:00:00 2001
From: Thomas--S <Thomas--S@users.noreply.github.com>
Date: Fri, 17 Oct 2025 00:17:52 +0200
Subject: [PATCH] Clarify set_yaw() behaviour in documentation

---
 doc/lua_api.md | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

diff --git a/doc/lua_api.md b/doc/lua_api.md
index 7ce6a543e..e94e34277 100644
--- a/doc/lua_api.md
+++ b/doc/lua_api.md
@@ -8651,7 +8651,9 @@ child will follow movement and rotation of that bone.
     * Does not reset rotation incurred through `automatic_rotate`.
       Remove & re-add your objects to force a certain rotation.
 * `get_rotation()`: returns the rotation, a vector (radians)
-* `set_yaw(yaw)`: sets the yaw in radians (heading).
+* `set_yaw(yaw)`
+    * Sets the yaw in radians (heading).
+    * Also resets pitch and roll to 0.
 * `get_yaw()`: returns number in radians
 * `set_texture_mod(mod)`
     * Set a texture modifier to the base texture, for sprites and meshes.