class_segmentshape2d.rst 2.5 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768
  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 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:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
  9. Segment shape for 2D collisions.
  10. Description
  11. -----------
  12. Segment shape for 2D collisions. Consists of two points, ``a`` and ``b``.
  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. Property Descriptions
  21. ---------------------
  22. .. _class_SegmentShape2D_property_a:
  23. - :ref:`Vector2<class_Vector2>` **a**
  24. +-----------+-------------------+
  25. | *Default* | ``Vector2(0, 0)`` |
  26. +-----------+-------------------+
  27. | *Setter* | set_a(value) |
  28. +-----------+-------------------+
  29. | *Getter* | get_a() |
  30. +-----------+-------------------+
  31. The segment's first point position.
  32. ----
  33. .. _class_SegmentShape2D_property_b:
  34. - :ref:`Vector2<class_Vector2>` **b**
  35. +-----------+--------------------+
  36. | *Default* | ``Vector2(0, 10)`` |
  37. +-----------+--------------------+
  38. | *Setter* | set_b(value) |
  39. +-----------+--------------------+
  40. | *Getter* | get_b() |
  41. +-----------+--------------------+
  42. The segment's second point position.
  43. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  44. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  45. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
  46. .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
  47. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
  48. .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`