class_path2d.rst 1.5 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647
  1. .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
  2. .. DO NOT EDIT THIS FILE, but the Path2D.xml source instead.
  3. .. The source is found in doc/classes or modules/<name>/doc_classes.
  4. .. _class_Path2D:
  5. Path2D
  6. ======
  7. **Inherits:** :ref:`Node2D<class_Node2D>` **<** :ref:`CanvasItem<class_CanvasItem>` **<** :ref:`Node<class_Node>` **<** :ref:`Object<class_Object>`
  8. **Category:** Core
  9. Brief Description
  10. -----------------
  11. Contains a :ref:`Curve2D<class_Curve2D>` path for :ref:`PathFollow2D<class_PathFollow2D>` nodes to follow.
  12. Properties
  13. ----------
  14. +-------------------------------+-------------------------------------------+
  15. | :ref:`Curve2D<class_Curve2D>` | :ref:`curve<class_Path2D_property_curve>` |
  16. +-------------------------------+-------------------------------------------+
  17. Description
  18. -----------
  19. Can have :ref:`PathFollow2D<class_PathFollow2D>` child nodes moving along the :ref:`Curve2D<class_Curve2D>`. See :ref:`PathFollow2D<class_PathFollow2D>` for more information on usage.
  20. **Note:** 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)``).
  21. Property Descriptions
  22. ---------------------
  23. .. _class_Path2D_property_curve:
  24. - :ref:`Curve2D<class_Curve2D>` **curve**
  25. +----------+------------------+
  26. | *Setter* | set_curve(value) |
  27. +----------+------------------+
  28. | *Getter* | get_curve() |
  29. +----------+------------------+
  30. A :ref:`Curve2D<class_Curve2D>` describing the path.