From 4f9365dedf92d5f059237eb95f42d1e332240c2b Mon Sep 17 00:00:00 2001
From: zacryol <60046681+zacryol@users.noreply.github.com>
Date: Sat, 8 Jan 2022 15:19:12 -0700
Subject: Expand description of is_on_X methods for CharacterBody2D/3D

Clarifies in the description for each method that the `up_direction` and `floor_max_angle`
properties are used to determine the status of a collided surface.
---
 doc/classes/CharacterBody3D.xml | 12 ++++++------
 1 file changed, 6 insertions(+), 6 deletions(-)

(limited to 'doc/classes/CharacterBody3D.xml')

diff --git a/doc/classes/CharacterBody3D.xml b/doc/classes/CharacterBody3D.xml
index e35471b4f6..819190fd69 100644
--- a/doc/classes/CharacterBody3D.xml
+++ b/doc/classes/CharacterBody3D.xml
@@ -81,37 +81,37 @@
 		<method name="is_on_ceiling" qualifiers="const">
 			<return type="bool" />
 			<description>
-				Returns [code]true[/code] if the body collided with the ceiling on the last call of [method move_and_slide]. Otherwise, returns [code]false[/code].
+				Returns [code]true[/code] if the body collided with the ceiling on the last call of [method move_and_slide]. Otherwise, returns [code]false[/code]. The [member up_direction] and [member floor_max_angle] are used to determine whether a surface is "ceiling" or not.
 			</description>
 		</method>
 		<method name="is_on_ceiling_only" qualifiers="const">
 			<return type="bool" />
 			<description>
-				Returns [code]true[/code] if the body collided only with the ceiling on the last call of [method move_and_slide]. Otherwise, returns [code]false[/code].
+				Returns [code]true[/code] if the body collided only with the ceiling on the last call of [method move_and_slide]. Otherwise, returns [code]false[/code]. The [member up_direction] and [member floor_max_angle] are used to determine whether a surface is "ceiling" or not.
 			</description>
 		</method>
 		<method name="is_on_floor" qualifiers="const">
 			<return type="bool" />
 			<description>
-				Returns [code]true[/code] if the body collided with the floor on the last call of [method move_and_slide]. Otherwise, returns [code]false[/code].
+				Returns [code]true[/code] if the body collided with the floor on the last call of [method move_and_slide]. Otherwise, returns [code]false[/code]. The [member up_direction] and [member floor_max_angle] are used to determine whether a surface is "floor" or not.
 			</description>
 		</method>
 		<method name="is_on_floor_only" qualifiers="const">
 			<return type="bool" />
 			<description>
-				Returns [code]true[/code] if the body collided only with the floor on the last call of [method move_and_slide]. Otherwise, returns [code]false[/code].
+				Returns [code]true[/code] if the body collided only with the floor on the last call of [method move_and_slide]. Otherwise, returns [code]false[/code]. The [member up_direction] and [member floor_max_angle] are used to determine whether a surface is "floor" or not.
 			</description>
 		</method>
 		<method name="is_on_wall" qualifiers="const">
 			<return type="bool" />
 			<description>
-				Returns [code]true[/code] if the body collided with a wall on the last call of [method move_and_slide]. Otherwise, returns [code]false[/code].
+				Returns [code]true[/code] if the body collided with a wall on the last call of [method move_and_slide]. Otherwise, returns [code]false[/code]. The [member up_direction] and [member floor_max_angle] are used to determine whether a surface is "wall" or not.
 			</description>
 		</method>
 		<method name="is_on_wall_only" qualifiers="const">
 			<return type="bool" />
 			<description>
-				Returns [code]true[/code] if the body collided only with a wall on the last call of [method move_and_slide]. Otherwise, returns [code]false[/code].
+				Returns [code]true[/code] if the body collided only with a wall on the last call of [method move_and_slide]. Otherwise, returns [code]false[/code]. The [member up_direction] and [member floor_max_angle] are used to determine whether a surface is "wall" or not.
 			</description>
 		</method>
 		<method name="move_and_slide">
-- 
cgit v1.2.3