stan220/godot-docs
1
0
Fork 0
mirror of https://github.com/stan220/godot-docs.git synced 2026-09-08 17:28:58 +00:00
Code Issues Packages Projects Releases Wiki Activity

classref: Add property overview and setter/getter like in editor docs

Browse Source 
Output from godotengine/godot#22013.
Fixes #1729.
This commit is contained in:
Rémi Verschelde
2018-09-13 11:06:52 +02:00
parent f9caa4be29
commit ab3f908221
578 changed files with 33831 additions and 6706 deletions
Download Patch File Download Diff File Expand all files Collapse all files
classes/class_shape2d.rst
+18 -6
View File
@@ -8,7 +8,9 @@ Shape2D
=======
**Inherits:** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
**Inherited By:** :ref:`RayShape2D<class_RayShape2D>`, :ref:`LineShape2D<class_LineShape2D>`, :ref:`CircleShape2D<class_CircleShape2D>`, :ref:`ConcavePolygonShape2D<class_ConcavePolygonShape2D>`, :ref:`ConvexPolygonShape2D<class_ConvexPolygonShape2D>`, :ref:`CapsuleShape2D<class_CapsuleShape2D>`, :ref:`RectangleShape2D<class_RectangleShape2D>`, :ref:`SegmentShape2D<class_SegmentShape2D>`
**Category:** Core
Brief Description
@@ -16,6 +18,13 @@ Brief Description
Base class for all 2D Shapes.
Properties
----------
+---------------------------+-------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`custom_solver_bias<class_Shape2D_custom_solver_bias>` |
+---------------------------+-------------------------------------------------------------+
Methods
-------
@@ -38,7 +47,6 @@ Tutorials
---------
- :doc:`../tutorials/physics/physics_introduction`
Property Descriptions
---------------------
@@ -46,11 +54,16 @@ Property Descriptions
- :ref:`float<class_float>` **custom_solver_bias**
+----------+-------------------------------+
| *Setter* | set_custom_solver_bias(value) |
+----------+-------------------------------+
| *Getter* | get_custom_solver_bias() |
+----------+-------------------------------+
Method Descriptions
-------------------
.. _class_Shape2D_collide:
.. _class_Shape2D_collide:
- :ref:`bool<class_bool>` **collide** **(** :ref:`Transform2D<class_Transform2D>` local_xform, :ref:`Shape2D<class_Shape2D>` with_shape, :ref:`Transform2D<class_Transform2D>` shape_xform **)**
@@ -58,7 +71,7 @@ Return whether 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``).
.. _class_Shape2D_collide_and_get_contacts:
.. _class_Shape2D_collide_and_get_contacts:
- :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 **)**
@@ -66,7 +79,7 @@ Return a list of the points where this shape touches another. If there are no co
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``).
.. _class_Shape2D_collide_with_motion:
.. _class_Shape2D_collide_with_motion:
- :ref:`bool<class_bool>` **collide_with_motion** **(** :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 **)**
@@ -74,7 +87,7 @@ Return whether this shape would collide with another, if a given movement was ap
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``).
.. _class_Shape2D_collide_with_motion_and_get_contacts:
.. _class_Shape2D_collide_with_motion_and_get_contacts:
- :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 **)**
@@ -82,4 +95,3 @@ Return a list of the points where this shape would touch another, if a given mov
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``).