Files
godot-docs/classes/class_path3d.rst
2021-10-06 11:19:07 +02:00

60 lines
2.3 KiB
ReStructuredText

:github_url: hide
.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the Path3D.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.
.. _class_Path3D:
Path3D
======
**Inherits:** :ref:`Node3D<class_Node3D>` **<** :ref:`Node<class_Node>` **<** :ref:`Object<class_Object>`
Contains a :ref:`Curve3D<class_Curve3D>` path for :ref:`PathFollow3D<class_PathFollow3D>` nodes to follow.
Description
-----------
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.
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)``.
Properties
----------
+-------------------------------+-------------------------------------------+
| :ref:`Curve3D<class_Curve3D>` | :ref:`curve<class_Path3D_property_curve>` |
+-------------------------------+-------------------------------------------+
Signals
-------
.. _class_Path3D_signal_curve_changed:
- **curve_changed** **(** **)**
Emitted when the :ref:`curve<class_Path3D_property_curve>` changes.
Property Descriptions
---------------------
.. _class_Path3D_property_curve:
- :ref:`Curve3D<class_Curve3D>` **curve**
+----------+------------------+
| *Setter* | set_curve(value) |
+----------+------------------+
| *Getter* | get_curve() |
+----------+------------------+
A :ref:`Curve3D<class_Curve3D>` describing the path.
.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
.. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
.. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
.. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`