Jelajahi Sumber

Merge pull request #2181 from ShadowKyogre/doc-help

Add documentation for RayCast2D about is_colliding and get_collider quirks
Juan Linietsky 10 tahun lalu
induk
melakukan
e3f4fbc755
1 mengubah file dengan 2 tambahan dan 0 penghapusan
  1. 2 0
      doc/base/classes.xml

+ 2 - 0
doc/base/classes.xml

@@ -23032,12 +23032,14 @@
 			<return type="bool">
 			<return type="bool">
 			</return>
 			</return>
 			<description>
 			<description>
+			Return whether the closest object the ray is pointing to is colliding with the vector, with the vector length considered.
 			</description>
 			</description>
 		</method>
 		</method>
 		<method name="get_collider" qualifiers="const" >
 		<method name="get_collider" qualifiers="const" >
 			<return type="Object">
 			<return type="Object">
 			</return>
 			</return>
 			<description>
 			<description>
+			Return the closest object the ray is pointing to. Note that this does not consider the length of the vector, so you must also use [is_colliding] to check if the object returned is actually colliding with the ray.
 			</description>
 			</description>
 		</method>
 		</method>
 		<method name="get_collider_shape" qualifiers="const" >
 		<method name="get_collider_shape" qualifiers="const" >