class_path3d.rst 2.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960
  1. :github_url: hide
  2. .. DO NOT EDIT THIS FILE!!!
  3. .. Generated automatically from Godot engine sources.
  4. .. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
  5. .. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/Path3D.xml.
  6. .. _class_Path3D:
  7. Path3D
  8. ======
  9. **Inherits:** :ref:`Node3D<class_Node3D>` **<** :ref:`Node<class_Node>` **<** :ref:`Object<class_Object>`
  10. Contains a :ref:`Curve3D<class_Curve3D>` path for :ref:`PathFollow3D<class_PathFollow3D>` nodes to follow.
  11. Description
  12. -----------
  13. 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.
  14. 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)``.
  15. Properties
  16. ----------
  17. +-------------------------------+-------------------------------------------+
  18. | :ref:`Curve3D<class_Curve3D>` | :ref:`curve<class_Path3D_property_curve>` |
  19. +-------------------------------+-------------------------------------------+
  20. Signals
  21. -------
  22. .. _class_Path3D_signal_curve_changed:
  23. - **curve_changed** **(** **)**
  24. Emitted when the :ref:`curve<class_Path3D_property_curve>` changes.
  25. Property Descriptions
  26. ---------------------
  27. .. _class_Path3D_property_curve:
  28. - :ref:`Curve3D<class_Curve3D>` **curve**
  29. +----------+------------------+
  30. | *Setter* | set_curve(value) |
  31. +----------+------------------+
  32. | *Getter* | get_curve() |
  33. +----------+------------------+
  34. A :ref:`Curve3D<class_Curve3D>` describing the path.
  35. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  36. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  37. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
  38. .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
  39. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
  40. .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`