Browse Source

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.
zacryol 3 years ago
parent
commit
4f9365dedf
2 changed files with 12 additions and 12 deletions
  1. 6 6
      doc/classes/CharacterBody2D.xml
  2. 6 6
      doc/classes/CharacterBody3D.xml

+ 6 - 6
doc/classes/CharacterBody2D.xml

@@ -95,37 +95,37 @@
 		<method name="is_on_ceiling" qualifiers="const">
 		<method name="is_on_ceiling" qualifiers="const">
 			<return type="bool" />
 			<return type="bool" />
 			<description>
 			<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>
 			</description>
 		</method>
 		</method>
 		<method name="is_on_ceiling_only" qualifiers="const">
 		<method name="is_on_ceiling_only" qualifiers="const">
 			<return type="bool" />
 			<return type="bool" />
 			<description>
 			<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>
 			</description>
 		</method>
 		</method>
 		<method name="is_on_floor" qualifiers="const">
 		<method name="is_on_floor" qualifiers="const">
 			<return type="bool" />
 			<return type="bool" />
 			<description>
 			<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>
 			</description>
 		</method>
 		</method>
 		<method name="is_on_floor_only" qualifiers="const">
 		<method name="is_on_floor_only" qualifiers="const">
 			<return type="bool" />
 			<return type="bool" />
 			<description>
 			<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>
 			</description>
 		</method>
 		</method>
 		<method name="is_on_wall" qualifiers="const">
 		<method name="is_on_wall" qualifiers="const">
 			<return type="bool" />
 			<return type="bool" />
 			<description>
 			<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>
 			</description>
 		</method>
 		</method>
 		<method name="is_on_wall_only" qualifiers="const">
 		<method name="is_on_wall_only" qualifiers="const">
 			<return type="bool" />
 			<return type="bool" />
 			<description>
 			<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>
 			</description>
 		</method>
 		</method>
 		<method name="move_and_slide">
 		<method name="move_and_slide">

+ 6 - 6
doc/classes/CharacterBody3D.xml

@@ -81,37 +81,37 @@
 		<method name="is_on_ceiling" qualifiers="const">
 		<method name="is_on_ceiling" qualifiers="const">
 			<return type="bool" />
 			<return type="bool" />
 			<description>
 			<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>
 			</description>
 		</method>
 		</method>
 		<method name="is_on_ceiling_only" qualifiers="const">
 		<method name="is_on_ceiling_only" qualifiers="const">
 			<return type="bool" />
 			<return type="bool" />
 			<description>
 			<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>
 			</description>
 		</method>
 		</method>
 		<method name="is_on_floor" qualifiers="const">
 		<method name="is_on_floor" qualifiers="const">
 			<return type="bool" />
 			<return type="bool" />
 			<description>
 			<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>
 			</description>
 		</method>
 		</method>
 		<method name="is_on_floor_only" qualifiers="const">
 		<method name="is_on_floor_only" qualifiers="const">
 			<return type="bool" />
 			<return type="bool" />
 			<description>
 			<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>
 			</description>
 		</method>
 		</method>
 		<method name="is_on_wall" qualifiers="const">
 		<method name="is_on_wall" qualifiers="const">
 			<return type="bool" />
 			<return type="bool" />
 			<description>
 			<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>
 			</description>
 		</method>
 		</method>
 		<method name="is_on_wall_only" qualifiers="const">
 		<method name="is_on_wall_only" qualifiers="const">
 			<return type="bool" />
 			<return type="bool" />
 			<description>
 			<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>
 			</description>
 		</method>
 		</method>
 		<method name="move_and_slide">
 		<method name="move_and_slide">