godot-docs/classes/class_ribbontrailmesh.rst

:github_url: hide

.. Generated automatically by doc/tools/make_rst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the RibbonTrailMesh.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.

.. _class_RibbonTrailMesh:

RibbonTrailMesh
===============

**Inherits:** :ref:`PrimitiveMesh<class_PrimitiveMesh>` **<** :ref:`Mesh<class_Mesh>` **<** :ref:`Resource<class_Resource>` **<** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`



Properties
----------

+------------------------------------------+--------------------------------------------------------------------------+---------+
| :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`` |
+------------------------------------------+--------------------------------------------------------------------------+---------+

Enumerations
------------

.. _enum_RibbonTrailMesh_Shape:

.. _class_RibbonTrailMesh_constant_SHAPE_FLAT:

.. _class_RibbonTrailMesh_constant_SHAPE_CROSS:

enum **Shape**:

- **SHAPE_FLAT** = **0**

- **SHAPE_CROSS** = **1**

Property Descriptions
---------------------

.. _class_RibbonTrailMesh_property_curve:

- :ref:`Curve<class_Curve>` **curve**

+----------+------------------+
| *Setter* | set_curve(value) |
+----------+------------------+
| *Getter* | get_curve()      |
+----------+------------------+

----

.. _class_RibbonTrailMesh_property_section_length:

- :ref:`float<class_float>` **section_length**

+-----------+---------------------------+
| *Default* | ``0.2``                   |
+-----------+---------------------------+
| *Setter*  | set_section_length(value) |
+-----------+---------------------------+
| *Getter*  | get_section_length()      |
+-----------+---------------------------+

----

.. _class_RibbonTrailMesh_property_section_segments:

- :ref:`int<class_int>` **section_segments**

+-----------+-----------------------------+
| *Default* | ``3``                       |
+-----------+-----------------------------+
| *Setter*  | set_section_segments(value) |
+-----------+-----------------------------+
| *Getter*  | get_section_segments()      |
+-----------+-----------------------------+

----

.. _class_RibbonTrailMesh_property_sections:

- :ref:`int<class_int>` **sections**

+-----------+---------------------+
| *Default* | ``5``               |
+-----------+---------------------+
| *Setter*  | set_sections(value) |
+-----------+---------------------+
| *Getter*  | get_sections()      |
+-----------+---------------------+

----

.. _class_RibbonTrailMesh_property_shape:

- :ref:`Shape<enum_RibbonTrailMesh_Shape>` **shape**

+-----------+------------------+
| *Default* | ``1``            |
+-----------+------------------+
| *Setter*  | set_shape(value) |
+-----------+------------------+
| *Getter*  | get_shape()      |
+-----------+------------------+

----

.. _class_RibbonTrailMesh_property_size:

- :ref:`float<class_float>` **size**

+-----------+-----------------+
| *Default* | ``1.0``         |
+-----------+-----------------+
| *Setter*  | set_size(value) |
+-----------+-----------------+
| *Getter*  | get_size()      |
+-----------+-----------------+

.. |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.)`