class_path.rst 1.6 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556
  1. .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
  2. .. DO NOT EDIT THIS FILE, but the Path.xml source instead.
  3. .. The source is found in doc/classes or modules/<name>/doc_classes.
  4. .. _class_Path:
  5. Path
  6. ====
  7. **Inherits:** :ref:`Spatial<class_Spatial>` **<** :ref:`Node<class_Node>` **<** :ref:`Object<class_Object>`
  8. **Category:** Core
  9. Brief Description
  10. -----------------
  11. Contains a :ref:`Curve3D<class_Curve3D>` path for :ref:`PathFollow<class_PathFollow>` nodes to follow.
  12. Properties
  13. ----------
  14. +-------------------------------+-----------------------------------------+
  15. | :ref:`Curve3D<class_Curve3D>` | :ref:`curve<class_Path_property_curve>` |
  16. +-------------------------------+-----------------------------------------+
  17. Signals
  18. -------
  19. .. _class_Path_signal_curve_changed:
  20. - **curve_changed** **(** **)**
  21. Emitted when the :ref:`curve<class_Path_property_curve>` changes.
  22. Description
  23. -----------
  24. Can have :ref:`PathFollow<class_PathFollow>` child nodes moving along the :ref:`Curve3D<class_Curve3D>`. See :ref:`PathFollow<class_PathFollow>` for more information on the usage.
  25. Note that the path is considered as relative to the moved nodes (children of :ref:`PathFollow<class_PathFollow>`). As such, the curve should usually start with a zero vector ``(0, 0, 0)``.
  26. Property Descriptions
  27. ---------------------
  28. .. _class_Path_property_curve:
  29. - :ref:`Curve3D<class_Curve3D>` **curve**
  30. +----------+------------------+
  31. | *Setter* | set_curve(value) |
  32. +----------+------------------+
  33. | *Getter* | get_curve() |
  34. +----------+------------------+
  35. A :ref:`Curve3D<class_Curve3D>` describing the path.