class_segmentshape2d.rst 1.8 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465
  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 SegmentShape2D.xml source instead.
  4. .. The source is found in doc/classes or modules/<name>/doc_classes.
  5. .. _class_SegmentShape2D:
  6. SegmentShape2D
  7. ==============
  8. **Inherits:** :ref:`Shape2D<class_Shape2D>` **<** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
  9. **Category:** Core
  10. Brief Description
  11. -----------------
  12. Segment shape for 2D collisions.
  13. Properties
  14. ----------
  15. +-------------------------------+-------------------------------------------+------------------+
  16. | :ref:`Vector2<class_Vector2>` | :ref:`a<class_SegmentShape2D_property_a>` | Vector2( 0, 0 ) |
  17. +-------------------------------+-------------------------------------------+------------------+
  18. | :ref:`Vector2<class_Vector2>` | :ref:`b<class_SegmentShape2D_property_b>` | Vector2( 0, 10 ) |
  19. +-------------------------------+-------------------------------------------+------------------+
  20. Description
  21. -----------
  22. Segment shape for 2D collisions. Consists of two points, ``a`` and ``b``.
  23. Property Descriptions
  24. ---------------------
  25. .. _class_SegmentShape2D_property_a:
  26. - :ref:`Vector2<class_Vector2>` **a**
  27. +-----------+-----------------+
  28. | *Default* | Vector2( 0, 0 ) |
  29. +-----------+-----------------+
  30. | *Setter* | set_a(value) |
  31. +-----------+-----------------+
  32. | *Getter* | get_a() |
  33. +-----------+-----------------+
  34. The segment's first point position.
  35. .. _class_SegmentShape2D_property_b:
  36. - :ref:`Vector2<class_Vector2>` **b**
  37. +-----------+------------------+
  38. | *Default* | Vector2( 0, 10 ) |
  39. +-----------+------------------+
  40. | *Setter* | set_b(value) |
  41. +-----------+------------------+
  42. | *Getter* | get_b() |
  43. +-----------+------------------+
  44. The segment's second point position.