2
0

class_rectangleshape2d.rst 1.8 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647
  1. :github_url: hide
  2. .. Generated automatically by doc/tools/makerst.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. Properties
  14. ----------
  15. +-------------------------------+---------------------------------------------------------+-----------------------+
  16. | :ref:`Vector2<class_Vector2>` | :ref:`extents<class_RectangleShape2D_property_extents>` | ``Vector2( 10, 10 )`` |
  17. +-------------------------------+---------------------------------------------------------+-----------------------+
  18. Property Descriptions
  19. ---------------------
  20. .. _class_RectangleShape2D_property_extents:
  21. - :ref:`Vector2<class_Vector2>` **extents**
  22. +-----------+-----------------------+
  23. | *Default* | ``Vector2( 10, 10 )`` |
  24. +-----------+-----------------------+
  25. | *Setter* | set_extents(value) |
  26. +-----------+-----------------------+
  27. | *Getter* | get_extents() |
  28. +-----------+-----------------------+
  29. The rectangle's half extents. The width and height of this shape is twice the half extents.
  30. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  31. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  32. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`