mirror of
https://github.com/Relintai/pandemonium_engine_docs.git
synced 2025-01-23 15:17:21 +01:00
58 lines
2.0 KiB
ReStructuredText
58 lines
2.0 KiB
ReStructuredText
|
:github_url: hide
|
||
|
|
|
||
|
|
.. DO NOT EDIT THIS FILE!!!
|
||
|
|
.. Generated automatically from Godot engine sources.
|
||
|
|
.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py.
|
||
|
|
.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/Path.xml.
|
||
|
|
|
||
|
|
.. _class_Path:
|
||
|
|
|
||
|
|
Path
|
||
|
|
====
|
||
|
|
|
||
|
|
**Inherits:** :ref:`Spatial<class_Spatial>` **<** :ref:`Node<class_Node>` **<** :ref:`Object<class_Object>`
|
||
|
|
|
||
|
|
Contains a :ref:`Curve3D<class_Curve3D>` path for :ref:`PathFollow<class_PathFollow>` nodes to follow.
|
||
|
|
|
||
|
|
Description
|
||
|
|
-----------
|
||
|
|
|
||
|
|
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.
|
||
|
|
|
||
|
|
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)``.
|
||
|
|
|
||
|
|
Properties
|
||
|
|
----------
|
||
|
|
|
||
|
|
+-------------------------------+-----------------------------------------+
|
||
|
|
| :ref:`Curve3D<class_Curve3D>` | :ref:`curve<class_Path_property_curve>` |
|
||
|
|
+-------------------------------+-----------------------------------------+
|
||
|
|
|
||
|
|
Signals
|
||
|
|
-------
|
||
|
|
|
||
|
|
.. _class_Path_signal_curve_changed:
|
||
|
|
|
||
|
|
- **curve_changed** **(** **)**
|
||
|
|
|
||
|
|
Emitted when the :ref:`curve<class_Path_property_curve>` changes.
|
||
|
|
|
||
|
|
Property Descriptions
|
||
|
|
---------------------
|
||
|
|
|
||
|
|
.. _class_Path_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.)`
|