class_lineshape2d.rst 2.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566
  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 LineShape2D.xml source instead.
  4. .. The source is found in doc/classes or modules/<name>/doc_classes.
  5. .. _class_LineShape2D:
  6. LineShape2D
  7. ===========
  8. **Inherits:** :ref:`Shape2D<class_Shape2D>` **<** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
  9. Line shape for 2D collisions.
  10. Description
  11. -----------
  12. Line shape for 2D collisions. It works like a 2D plane and will not allow any physics body to go to the negative side. Not recommended for rigid bodies, and usually not recommended for static bodies either because it forces checks against it on every frame.
  13. Properties
  14. ----------
  15. +-------------------------------+--------------------------------------------------+----------------------+
  16. | :ref:`float<class_float>` | :ref:`d<class_LineShape2D_property_d>` | ``0.0`` |
  17. +-------------------------------+--------------------------------------------------+----------------------+
  18. | :ref:`Vector2<class_Vector2>` | :ref:`normal<class_LineShape2D_property_normal>` | ``Vector2( 0, -1 )`` |
  19. +-------------------------------+--------------------------------------------------+----------------------+
  20. Property Descriptions
  21. ---------------------
  22. .. _class_LineShape2D_property_d:
  23. - :ref:`float<class_float>` **d**
  24. +-----------+--------------+
  25. | *Default* | ``0.0`` |
  26. +-----------+--------------+
  27. | *Setter* | set_d(value) |
  28. +-----------+--------------+
  29. | *Getter* | get_d() |
  30. +-----------+--------------+
  31. The line's distance from the origin.
  32. ----
  33. .. _class_LineShape2D_property_normal:
  34. - :ref:`Vector2<class_Vector2>` **normal**
  35. +-----------+----------------------+
  36. | *Default* | ``Vector2( 0, -1 )`` |
  37. +-----------+----------------------+
  38. | *Setter* | set_normal(value) |
  39. +-----------+----------------------+
  40. | *Getter* | get_normal() |
  41. +-----------+----------------------+
  42. The line's normal.
  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.)`