summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorGamepro5 <gamepro543@gmail.com>2024-04-05 03:12:46 -0700
committerRémi Verschelde <rverschelde@gmail.com>2024-04-08 11:09:18 +0200
commit4e1305ee7716b413e424850439607ba32fb24645 (patch)
treed974b27f0a2de120dd6f6a0ccedd3ad15e2a3e90 /doc
parente5b4ef8e9522e950033cbece39a31a4a76da19c1 (diff)
downloadredot-engine-4e1305ee7716b413e424850439607ba32fb24645.tar.gz
Specify that get_floor_normal() does not return the surface normal
Also see godotengine/godot-proposals#8324
Diffstat (limited to 'doc')
-rw-r--r--doc/classes/CharacterBody3D.xml3
1 files changed, 2 insertions, 1 deletions
diff --git a/doc/classes/CharacterBody3D.xml b/doc/classes/CharacterBody3D.xml
index 2382c77a12..8b8b57decb 100644
--- a/doc/classes/CharacterBody3D.xml
+++ b/doc/classes/CharacterBody3D.xml
@@ -31,7 +31,8 @@
<method name="get_floor_normal" qualifiers="const">
<return type="Vector3" />
<description>
- Returns the surface normal of the floor at the last collision point. Only valid after calling [method move_and_slide] and when [method is_on_floor] returns [code]true[/code].
+ Returns the collision normal of the floor at the last collision point. Only valid after calling [method move_and_slide] and when [method is_on_floor] returns [code]true[/code].
+ [b]Warning:[/b] The collision normal is not always the same as the surface normal.
</description>
</method>
<method name="get_last_motion" qualifiers="const">