summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorhomer666 <homer666@users.noreply.github.com>2018-09-23 09:18:55 +1000
committerhomer666 <homer666@users.noreply.github.com>2018-09-23 09:31:37 +1000
commit194f4760951a2323e3095936ca734b2d98e76f6c (patch)
tree6e6aefd10212c7d9d4037f6a977433eac62d33ea /doc
parent2613e59f59a67d78214e58cdb8856f50bfc08b19 (diff)
[DOCS] PhysicsDirectSpaceState updates
Diffstat (limited to 'doc')
-rw-r--r--doc/classes/Physics2DDirectSpaceState.xml2
-rw-r--r--doc/classes/PhysicsDirectSpaceState.xml6
2 files changed, 4 insertions, 4 deletions
diff --git a/doc/classes/Physics2DDirectSpaceState.xml b/doc/classes/Physics2DDirectSpaceState.xml
index 483c71b2c0..aa54d9a11a 100644
--- a/doc/classes/Physics2DDirectSpaceState.xml
+++ b/doc/classes/Physics2DDirectSpaceState.xml
@@ -117,7 +117,7 @@
[code]metadata[/code]: The intersecting shape's metadata. This metadata is different from [method Object.get_meta], and is set with [method Physics2DServer.shape_set_data].
[code]rid[/code]: The intersecting object's [RID].
[code]shape[/code]: The shape index of the colliding shape.
- The number of intersections can be limited with the second parameter, to reduce the processing time.
+ The number of intersections can be limited with the [code]max_results[/code] parameter, to reduce the processing time.
</description>
</method>
</methods>
diff --git a/doc/classes/PhysicsDirectSpaceState.xml b/doc/classes/PhysicsDirectSpaceState.xml
index 2f7cf5a8f3..1fd00fa21c 100644
--- a/doc/classes/PhysicsDirectSpaceState.xml
+++ b/doc/classes/PhysicsDirectSpaceState.xml
@@ -21,7 +21,7 @@
</argument>
<description>
Checks whether the shape can travel to a point. The method will return an array with two floats between 0 and 1, both representing a fraction of [code]motion[/code]. The first is how far the shape can move without triggering a collision, and the second is the point at which a collision will occur. If no collision is detected, the returned array will be [1, 1].
- If the shape can not move, the array will be empty.
+ If the shape can not move, the returned array will be [0, 0].
</description>
</method>
<method name="collide_shape">
@@ -41,7 +41,7 @@
<argument index="0" name="shape" type="PhysicsShapeQueryParameters">
</argument>
<description>
- Checks the intersections of a shape, given through a [PhysicsShapeQueryParameters] object, against the space. If it collides with more than a shape, the nearest one is selected. The returned object is a dictionary containing the following fields:
+ Checks the intersections of a shape, given through a [PhysicsShapeQueryParameters] object, against the space. If it collides with more than one shape, the nearest one is selected. The returned object is a dictionary containing the following fields:
[code]collider_id[/code]: The colliding object's ID.
[code]linear_velocity[/code]: The colliding object's velocity [Vector3]. If the object is an [Area], the result is [code](0, 0, 0)[/code].
[code]normal[/code]: The object's surface normal at the intersection point.
@@ -91,7 +91,7 @@
[code]collider_id[/code]: The colliding object's ID.
[code]rid[/code]: The intersecting object's [RID].
[code]shape[/code]: The shape index of the colliding shape.
- The number of intersections can be limited with the second parameter, to reduce the processing time.
+ The number of intersections can be limited with the [code]max_results[/code] parameter, to reduce the processing time.
</description>
</method>
</methods>