Files
godot-docs/classes/class_ribbontrailmesh.rst
2023-05-19 13:35:34 +00:00

197 lines
6.7 KiB
ReStructuredText

:github_url: hide
.. DO NOT EDIT THIS FILE!!!
.. Generated automatically from Godot engine sources.
.. Generator: https://github.com/godotengine/godot/tree/4.0/doc/tools/make_rst.py.
.. XML source: https://github.com/godotengine/godot/tree/4.0/doc/classes/RibbonTrailMesh.xml.
.. _class_RibbonTrailMesh:
RibbonTrailMesh
===============
**Inherits:** :ref:`PrimitiveMesh<class_PrimitiveMesh>` **<** :ref:`Mesh<class_Mesh>` **<** :ref:`Resource<class_Resource>` **<** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
.. container:: contribute
There is currently no description for this class. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
.. rst-class:: classref-reftable-group
Properties
----------
.. table::
:widths: auto
+------------------------------------------+--------------------------------------------------------------------------+---------+
| :ref:`Curve<class_Curve>` | :ref:`curve<class_RibbonTrailMesh_property_curve>` | |
+------------------------------------------+--------------------------------------------------------------------------+---------+
| :ref:`float<class_float>` | :ref:`section_length<class_RibbonTrailMesh_property_section_length>` | ``0.2`` |
+------------------------------------------+--------------------------------------------------------------------------+---------+
| :ref:`int<class_int>` | :ref:`section_segments<class_RibbonTrailMesh_property_section_segments>` | ``3`` |
+------------------------------------------+--------------------------------------------------------------------------+---------+
| :ref:`int<class_int>` | :ref:`sections<class_RibbonTrailMesh_property_sections>` | ``5`` |
+------------------------------------------+--------------------------------------------------------------------------+---------+
| :ref:`Shape<enum_RibbonTrailMesh_Shape>` | :ref:`shape<class_RibbonTrailMesh_property_shape>` | ``1`` |
+------------------------------------------+--------------------------------------------------------------------------+---------+
| :ref:`float<class_float>` | :ref:`size<class_RibbonTrailMesh_property_size>` | ``1.0`` |
+------------------------------------------+--------------------------------------------------------------------------+---------+
.. rst-class:: classref-section-separator
----
.. rst-class:: classref-descriptions-group
Enumerations
------------
.. _enum_RibbonTrailMesh_Shape:
.. rst-class:: classref-enumeration
enum **Shape**:
.. _class_RibbonTrailMesh_constant_SHAPE_FLAT:
.. rst-class:: classref-enumeration-constant
:ref:`Shape<enum_RibbonTrailMesh_Shape>` **SHAPE_FLAT** = ``0``
.. _class_RibbonTrailMesh_constant_SHAPE_CROSS:
.. rst-class:: classref-enumeration-constant
:ref:`Shape<enum_RibbonTrailMesh_Shape>` **SHAPE_CROSS** = ``1``
.. rst-class:: classref-section-separator
----
.. rst-class:: classref-descriptions-group
Property Descriptions
---------------------
.. _class_RibbonTrailMesh_property_curve:
.. rst-class:: classref-property
:ref:`Curve<class_Curve>` **curve**
.. rst-class:: classref-property-setget
- void **set_curve** **(** :ref:`Curve<class_Curve>` value **)**
- :ref:`Curve<class_Curve>` **get_curve** **(** **)**
.. container:: contribute
There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
.. rst-class:: classref-item-separator
----
.. _class_RibbonTrailMesh_property_section_length:
.. rst-class:: classref-property
:ref:`float<class_float>` **section_length** = ``0.2``
.. rst-class:: classref-property-setget
- void **set_section_length** **(** :ref:`float<class_float>` value **)**
- :ref:`float<class_float>` **get_section_length** **(** **)**
.. container:: contribute
There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
.. rst-class:: classref-item-separator
----
.. _class_RibbonTrailMesh_property_section_segments:
.. rst-class:: classref-property
:ref:`int<class_int>` **section_segments** = ``3``
.. rst-class:: classref-property-setget
- void **set_section_segments** **(** :ref:`int<class_int>` value **)**
- :ref:`int<class_int>` **get_section_segments** **(** **)**
.. container:: contribute
There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
.. rst-class:: classref-item-separator
----
.. _class_RibbonTrailMesh_property_sections:
.. rst-class:: classref-property
:ref:`int<class_int>` **sections** = ``5``
.. rst-class:: classref-property-setget
- void **set_sections** **(** :ref:`int<class_int>` value **)**
- :ref:`int<class_int>` **get_sections** **(** **)**
.. container:: contribute
There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
.. rst-class:: classref-item-separator
----
.. _class_RibbonTrailMesh_property_shape:
.. rst-class:: classref-property
:ref:`Shape<enum_RibbonTrailMesh_Shape>` **shape** = ``1``
.. rst-class:: classref-property-setget
- void **set_shape** **(** :ref:`Shape<enum_RibbonTrailMesh_Shape>` value **)**
- :ref:`Shape<enum_RibbonTrailMesh_Shape>` **get_shape** **(** **)**
.. container:: contribute
There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
.. rst-class:: classref-item-separator
----
.. _class_RibbonTrailMesh_property_size:
.. rst-class:: classref-property
:ref:`float<class_float>` **size** = ``1.0``
.. rst-class:: classref-property-setget
- void **set_size** **(** :ref:`float<class_float>` value **)**
- :ref:`float<class_float>` **get_size** **(** **)**
.. container:: contribute
There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
.. |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.)`