Sync classref with current source

This commit is contained in:
Rémi Verschelde
2018-09-17 12:16:25 +02:00
parent dccb4bb8e0
commit a4d72396d8
9 changed files with 67 additions and 26 deletions
+3 -3
View File
@@ -67,7 +67,7 @@ Method Descriptions
- :ref:`bool<class_bool>` **collide** **(** :ref:`Transform2D<class_Transform2D>` local_xform, :ref:`Shape2D<class_Shape2D>` with_shape, :ref:`Transform2D<class_Transform2D>` shape_xform **)**
Return whether this shape is colliding with another.
Returns ``true`` if this shape is colliding with another.
This method needs the transformation matrix for this shape (``local_xform``), the shape to check collisions with (``with_shape``), and the transformation matrix of that shape (``shape_xform``).
@@ -75,7 +75,7 @@ This method needs the transformation matrix for this shape (``local_xform``), th
- :ref:`Variant<class_Variant>` **collide_and_get_contacts** **(** :ref:`Transform2D<class_Transform2D>` local_xform, :ref:`Shape2D<class_Shape2D>` with_shape, :ref:`Transform2D<class_Transform2D>` shape_xform **)**
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 (``local_xform``), the shape to check collisions with (``with_shape``), and the transformation matrix of that shape (``shape_xform``).
@@ -91,7 +91,7 @@ This method needs the transformation matrix for this shape (``local_xform``), th
- :ref:`Variant<class_Variant>` **collide_with_motion_and_get_contacts** **(** :ref:`Transform2D<class_Transform2D>` local_xform, :ref:`Vector2<class_Vector2>` local_motion, :ref:`Shape2D<class_Shape2D>` with_shape, :ref:`Transform2D<class_Transform2D>` shape_xform, :ref:`Vector2<class_Vector2>` shape_motion **)**
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 (``local_xform``), the movement to test on this shape (``local_motion``), the shape to check collisions with (``with_shape``), the transformation matrix of that shape (``shape_xform``), and the movement to test onto the other object (``shape_motion``).