Explorar o código

RayCast2D and RayCast3D documentation: warn to check is_colliding

Ricardo Buring hai 1 ano
pai
achega
8effd6b513
Modificáronse 2 ficheiros con 6 adicións e 4 borrados
  1. 3 2
      doc/classes/RayCast2D.xml
  2. 3 2
      doc/classes/RayCast3D.xml

+ 3 - 2
doc/classes/RayCast2D.xml

@@ -69,13 +69,14 @@
 			<return type="Vector2" />
 			<description>
 				Returns the normal of the intersecting object's shape at the collision point, or [code]Vector2(0, 0)[/code] if the ray starts inside the shape and [member hit_from_inside] is [code]true[/code].
+				[b]Note:[/b] Check that [method is_colliding] returns [code]true[/code] before calling this method to ensure the returned normal is valid and up-to-date.
 			</description>
 		</method>
 		<method name="get_collision_point" qualifiers="const">
 			<return type="Vector2" />
 			<description>
-				Returns the collision point at which the ray intersects the closest object. If [member hit_from_inside] is [code]true[/code] and the ray starts inside of a collision shape, this function will return the origin point of the ray.
-				[b]Note:[/b] This point is in the [b]global[/b] coordinate system.
+				Returns the collision point at which the ray intersects the closest object, in the global coordinate system. If [member hit_from_inside] is [code]true[/code] and the ray starts inside of a collision shape, this function will return the origin point of the ray.
+				[b]Note:[/b] Check that [method is_colliding] returns [code]true[/code] before calling this method to ensure the returned point is valid and up-to-date.
 			</description>
 		</method>
 		<method name="is_colliding" qualifiers="const">

+ 3 - 2
doc/classes/RayCast3D.xml

@@ -76,13 +76,14 @@
 			<return type="Vector3" />
 			<description>
 				Returns the normal of the intersecting object's shape at the collision point, or [code]Vector3(0, 0, 0)[/code] if the ray starts inside the shape and [member hit_from_inside] is [code]true[/code].
+				[b]Note:[/b] Check that [method is_colliding] returns [code]true[/code] before calling this method to ensure the returned normal is valid and up-to-date.
 			</description>
 		</method>
 		<method name="get_collision_point" qualifiers="const">
 			<return type="Vector3" />
 			<description>
-				Returns the collision point at which the ray intersects the closest object. If [member hit_from_inside] is [code]true[/code] and the ray starts inside of a collision shape, this function will return the origin point of the ray.
-				[b]Note:[/b] This point is in the [b]global[/b] coordinate system.
+				Returns the collision point at which the ray intersects the closest object, in the global coordinate system. If [member hit_from_inside] is [code]true[/code] and the ray starts inside of a collision shape, this function will return the origin point of the ray.
+				[b]Note:[/b] Check that [method is_colliding] returns [code]true[/code] before calling this method to ensure the returned point is valid and up-to-date.
 			</description>
 		</method>
 		<method name="is_colliding" qualifiers="const">