class_lineshape2d.rst 1.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263
  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 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. **Category:** Core
  10. Brief Description
  11. -----------------
  12. Line shape for 2D collisions.
  13. Properties
  14. ----------
  15. +-------------------------------+--------------------------------------------------+
  16. | :ref:`float<class_float>` | :ref:`d<class_LineShape2D_property_d>` |
  17. +-------------------------------+--------------------------------------------------+
  18. | :ref:`Vector2<class_Vector2>` | :ref:`normal<class_LineShape2D_property_normal>` |
  19. +-------------------------------+--------------------------------------------------+
  20. Description
  21. -----------
  22. Line shape for 2D collisions. It works like a 2D plane and will not allow any 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.
  23. Property Descriptions
  24. ---------------------
  25. .. _class_LineShape2D_property_d:
  26. - :ref:`float<class_float>` **d**
  27. +----------+--------------+
  28. | *Setter* | set_d(value) |
  29. +----------+--------------+
  30. | *Getter* | get_d() |
  31. +----------+--------------+
  32. The line's distance from the origin.
  33. ----
  34. .. _class_LineShape2D_property_normal:
  35. - :ref:`Vector2<class_Vector2>` **normal**
  36. +----------+-------------------+
  37. | *Setter* | set_normal(value) |
  38. +----------+-------------------+
  39. | *Getter* | get_normal() |
  40. +----------+-------------------+
  41. The line's normal.