class_rectangleshape2d.rst 2.0 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455
  1. :github_url: hide
  2. .. Generated automatically by doc/tools/make_rst.py in Godot's source tree.
  3. .. DO NOT EDIT THIS FILE, but the RectangleShape2D.xml source instead.
  4. .. The source is found in doc/classes or modules/<name>/doc_classes.
  5. .. _class_RectangleShape2D:
  6. RectangleShape2D
  7. ================
  8. **Inherits:** :ref:`Shape2D<class_Shape2D>` **<** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
  9. Rectangle shape for 2D collisions.
  10. Description
  11. -----------
  12. Rectangle shape for 2D collisions. This shape is useful for modeling box-like 2D objects.
  13. Tutorials
  14. ---------
  15. - `2D Pong Demo <https://godotengine.org/asset-library/asset/121>`__
  16. - `2D Kinematic Character Demo <https://godotengine.org/asset-library/asset/113>`__
  17. Properties
  18. ----------
  19. +-------------------------------+---------------------------------------------------------+-----------------------+
  20. | :ref:`Vector2<class_Vector2>` | :ref:`extents<class_RectangleShape2D_property_extents>` | ``Vector2( 10, 10 )`` |
  21. +-------------------------------+---------------------------------------------------------+-----------------------+
  22. Property Descriptions
  23. ---------------------
  24. .. _class_RectangleShape2D_property_extents:
  25. - :ref:`Vector2<class_Vector2>` **extents**
  26. +-----------+-----------------------+
  27. | *Default* | ``Vector2( 10, 10 )`` |
  28. +-----------+-----------------------+
  29. | *Setter* | set_extents(value) |
  30. +-----------+-----------------------+
  31. | *Getter* | get_extents() |
  32. +-----------+-----------------------+
  33. The rectangle's half extents. The width and height of this shape is twice the half extents.
  34. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  35. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  36. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`