mirror of
https://github.com/godotengine/godot-docs.git
synced 2025-12-31 17:49:03 +03:00
50 lines
2.9 KiB
ReStructuredText
50 lines
2.9 KiB
ReStructuredText
.. 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>`
|
|
|
|
**Category:** Core
|
|
|
|
Brief Description
|
|
-----------------
|
|
|
|
Contains a :ref:`Curve2D<class_Curve2D>` path for :ref:`PathFollow2D<class_PathFollow2D>` nodes to follow.
|
|
|
|
Properties
|
|
----------
|
|
|
|
+-------------------------------+-------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`Curve2D<class_Curve2D>` | :ref:`curve<class_Path2D_property_curve>` | Object(Curve2D,"resource_local_to_scene":false,"resource_name":"","bake_interval":5.0,"_data":{ "points": PoolVector2Array( ) },"script":null) |
|
|
+-------------------------------+-------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
|
|
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)``).
|
|
|
|
Property Descriptions
|
|
---------------------
|
|
|
|
.. _class_Path2D_property_curve:
|
|
|
|
- :ref:`Curve2D<class_Curve2D>` **curve**
|
|
|
|
+-----------+--------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| *Default* | Object(Curve2D,"resource_local_to_scene":false,"resource_name":"","bake_interval":5.0,"_data":{ "points": PoolVector2Array( ) },"script":null) |
|
|
+-----------+--------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| *Setter* | set_curve(value) |
|
|
+-----------+--------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| *Getter* | get_curve() |
|
|
+-----------+--------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
|
|
A :ref:`Curve2D<class_Curve2D>` describing the path.
|
|
|