class_path2d.rst 2.2 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950
  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 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. Contains a :ref:`Curve2D<class_Curve2D>` path for :ref:`PathFollow2D<class_PathFollow2D>` nodes to follow.
  10. Description
  11. -----------
  12. 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.
  13. **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)``).
  14. Properties
  15. ----------
  16. +-------------------------------+-------------------------------------------+---------------------------------------------------+
  17. | :ref:`Curve2D<class_Curve2D>` | :ref:`curve<class_Path2D_property_curve>` | |
  18. +-------------------------------+-------------------------------------------+---------------------------------------------------+
  19. | :ref:`Color<class_Color>` | self_modulate | ``Color( 0.5, 0.6, 1, 0.7 )`` *(parent override)* |
  20. +-------------------------------+-------------------------------------------+---------------------------------------------------+
  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.
  31. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  32. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  33. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`