diff options
| author | Chris Bradfield <chris@kidscancode.org> | 2018-09-16 10:52:21 -0700 |
|---|---|---|
| committer | Chris Bradfield <chris@kidscancode.org> | 2018-09-16 10:52:21 -0700 |
| commit | ec5cc708ce987259ba9667bf48e4445fa675d94a (patch) | |
| tree | 81cbfab7b7e443347284c60e32673c64116baa4c /doc/classes/Shape2D.xml | |
| parent | 5961a6da03e70dbfa811c30c4ec684d3a7746bf6 (diff) | |
[DOCS] Classref additions and consistency fixes
Diffstat (limited to 'doc/classes/Shape2D.xml')
| -rw-r--r-- | doc/classes/Shape2D.xml | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/doc/classes/Shape2D.xml b/doc/classes/Shape2D.xml index 6c13496fc4..2772538cec 100644 --- a/doc/classes/Shape2D.xml +++ b/doc/classes/Shape2D.xml @@ -22,7 +22,7 @@ <argument index="2" name="shape_xform" type="Transform2D"> </argument> <description> - Return whether this shape is colliding with another. + Returns [code]true[/code] if this shape is colliding with another. This method needs the transformation matrix for this shape ([code]local_xform[/code]), the shape to check collisions with ([code]with_shape[/code]), and the transformation matrix of that shape ([code]shape_xform[/code]). </description> </method> @@ -36,7 +36,7 @@ <argument index="2" name="shape_xform" type="Transform2D"> </argument> <description> - Return a list of the points where this shape touches another. If there are no collisions, the list is empty. + Returns a list of the points where this shape touches another. If there are no collisions the list is empty. This method needs the transformation matrix for this shape ([code]local_xform[/code]), the shape to check collisions with ([code]with_shape[/code]), and the transformation matrix of that shape ([code]shape_xform[/code]). </description> </method> @@ -72,7 +72,7 @@ <argument index="4" name="shape_motion" type="Vector2"> </argument> <description> - Return a list of the points where this shape would touch another, if a given movement was applied. If there are no collisions, the list is empty. + Returns a list of the points where this shape would touch another, if a given movement was applied. If there are no collisions the list is empty. This method needs the transformation matrix for this shape ([code]local_xform[/code]), the movement to test on this shape ([code]local_motion[/code]), the shape to check collisions with ([code]with_shape[/code]), the transformation matrix of that shape ([code]shape_xform[/code]), and the movement to test onto the other object ([code]shape_motion[/code]). </description> </method> |