Files
godot-docs/classes/class_path2d.rst
Rémi Verschelde 782dd64a19 classref: Use code markup for default values/overrides
Sync with godotengine/godot#35357.
Fixes #3071.
2020-01-20 12:41:39 +01:00

47 lines
1.8 KiB
ReStructuredText

:github_url: hide
.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the Path2D.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.
.. _class_Path2D:
Path2D
======
**Inherits:** :ref:`Node2D<class_Node2D>` **<** :ref:`CanvasItem<class_CanvasItem>` **<** :ref:`Node<class_Node>` **<** :ref:`Object<class_Object>`
Contains a :ref:`Curve2D<class_Curve2D>` path for :ref:`PathFollow2D<class_PathFollow2D>` nodes to follow.
Description
-----------
Can have :ref:`PathFollow2D<class_PathFollow2D>` child nodes moving along the :ref:`Curve2D<class_Curve2D>`. See :ref:`PathFollow2D<class_PathFollow2D>` for more information on usage.
**Note:** The path is considered as relative to the moved nodes (children of :ref:`PathFollow2D<class_PathFollow2D>`). As such, the curve should usually start with a zero vector (``(0, 0)``).
Properties
----------
+-------------------------------+-------------------------------------------+--------------------------------------+
| :ref:`Curve2D<class_Curve2D>` | :ref:`curve<class_Path2D_property_curve>` | |
+-------------------------------+-------------------------------------------+--------------------------------------+
| :ref:`Color<class_Color>` | self_modulate | **O:** ``Color( 0.5, 0.6, 1, 0.7 )`` |
+-------------------------------+-------------------------------------------+--------------------------------------+
Property Descriptions
---------------------
.. _class_Path2D_property_curve:
- :ref:`Curve2D<class_Curve2D>` **curve**
+----------+------------------+
| *Setter* | set_curve(value) |
+----------+------------------+
| *Getter* | get_curve() |
+----------+------------------+
A :ref:`Curve2D<class_Curve2D>` describing the path.