class_path3d.rst 2.3 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859
  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 Path3D.xml source instead.
  4. .. The source is found in doc/classes or modules/<name>/doc_classes.
  5. .. _class_Path3D:
  6. Path3D
  7. ======
  8. **Inherits:** :ref:`Node3D<class_Node3D>` **<** :ref:`Node<class_Node>` **<** :ref:`Object<class_Object>`
  9. Contains a :ref:`Curve3D<class_Curve3D>` path for :ref:`PathFollow3D<class_PathFollow3D>` nodes to follow.
  10. Description
  11. -----------
  12. Can have :ref:`PathFollow3D<class_PathFollow3D>` child nodes moving along the :ref:`Curve3D<class_Curve3D>`. See :ref:`PathFollow3D<class_PathFollow3D>` for more information on the usage.
  13. Note that the path is considered as relative to the moved nodes (children of :ref:`PathFollow3D<class_PathFollow3D>`). As such, the curve should usually start with a zero vector ``(0, 0, 0)``.
  14. Properties
  15. ----------
  16. +-------------------------------+-------------------------------------------+
  17. | :ref:`Curve3D<class_Curve3D>` | :ref:`curve<class_Path3D_property_curve>` |
  18. +-------------------------------+-------------------------------------------+
  19. Signals
  20. -------
  21. .. _class_Path3D_signal_curve_changed:
  22. - **curve_changed** **(** **)**
  23. Emitted when the :ref:`curve<class_Path3D_property_curve>` changes.
  24. Property Descriptions
  25. ---------------------
  26. .. _class_Path3D_property_curve:
  27. - :ref:`Curve3D<class_Curve3D>` **curve**
  28. +----------+------------------+
  29. | *Setter* | set_curve(value) |
  30. +----------+------------------+
  31. | *Getter* | get_curve() |
  32. +----------+------------------+
  33. A :ref:`Curve3D<class_Curve3D>` describing the path.
  34. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  35. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  36. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
  37. .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
  38. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
  39. .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`