class_path2d.rst 1.5 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849
  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 Path2D.xml source instead.
  4. .. The source is found in doc/classes or modules/<name>/doc_classes.
  5. .. _class_Path2D:
  6. Path2D
  7. ======
  8. **Inherits:** :ref:`Node2D<class_Node2D>` **<** :ref:`CanvasItem<class_CanvasItem>` **<** :ref:`Node<class_Node>` **<** :ref:`Object<class_Object>`
  9. **Category:** Core
  10. Brief Description
  11. -----------------
  12. Contains a :ref:`Curve2D<class_Curve2D>` path for :ref:`PathFollow2D<class_PathFollow2D>` nodes to follow.
  13. Properties
  14. ----------
  15. +-------------------------------+-------------------------------------------+
  16. | :ref:`Curve2D<class_Curve2D>` | :ref:`curve<class_Path2D_property_curve>` |
  17. +-------------------------------+-------------------------------------------+
  18. Description
  19. -----------
  20. Can have :ref:`PathFollow2D<class_PathFollow2D>` child nodes moving along the :ref:`Curve2D<class_Curve2D>`. See :ref:`PathFollow2D<class_PathFollow2D>` for more information on the usage.
  21. Note that the path is considered as relative to the moved nodes (children of :ref:`PathFollow2D<class_PathFollow2D>`). As such, the curve should usually start with a zero vector ``(0, 0)``.
  22. Property Descriptions
  23. ---------------------
  24. .. _class_Path2D_property_curve:
  25. - :ref:`Curve2D<class_Curve2D>` **curve**
  26. +----------+------------------+
  27. | *Setter* | set_curve(value) |
  28. +----------+------------------+
  29. | *Getter* | get_curve() |
  30. +----------+------------------+
  31. A :ref:`Curve2D<class_Curve2D>` describing the path.