mirror of
https://github.com/Relintai/pandemonium_engine_docs.git
synced 2025-01-23 15:17:21 +01:00
51 lines
2.5 KiB
ReStructuredText
51 lines
2.5 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/Path2D.xml.
|
|
|
|
.. _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 | ``Color( 0.5, 0.6, 1, 0.7 )`` (overrides :ref:`CanvasItem<class_CanvasItem_property_self_modulate>`) |
|
|
+-------------------------------+-------------------------------------------+------------------------------------------------------------------------------------------------------+
|
|
|
|
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.
|
|
|
|
.. |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.)`
|