Files
godot-docs/classes/class_ribbontrailmesh.rst
2022-11-17 21:03:53 +01:00

164 lines
6.3 KiB
ReStructuredText

:github_url: hide
.. DO NOT EDIT THIS FILE!!!
.. Generated automatically from Godot engine sources.
.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
.. XML source: https://github.com/godotengine/godot/tree/master/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>`!
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() |
+----------+------------------+
.. container:: contribute
There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
----
.. _class_RibbonTrailMesh_property_section_length:
- :ref:`float<class_float>` **section_length**
+-----------+---------------------------+
| *Default* | ``0.2`` |
+-----------+---------------------------+
| *Setter* | set_section_length(value) |
+-----------+---------------------------+
| *Getter* | 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>`!
----
.. _class_RibbonTrailMesh_property_section_segments:
- :ref:`int<class_int>` **section_segments**
+-----------+-----------------------------+
| *Default* | ``3`` |
+-----------+-----------------------------+
| *Setter* | set_section_segments(value) |
+-----------+-----------------------------+
| *Getter* | 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>`!
----
.. _class_RibbonTrailMesh_property_sections:
- :ref:`int<class_int>` **sections**
+-----------+---------------------+
| *Default* | ``5`` |
+-----------+---------------------+
| *Setter* | set_sections(value) |
+-----------+---------------------+
| *Getter* | get_sections() |
+-----------+---------------------+
.. container:: contribute
There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
----
.. _class_RibbonTrailMesh_property_shape:
- :ref:`Shape<enum_RibbonTrailMesh_Shape>` **shape**
+-----------+------------------+
| *Default* | ``1`` |
+-----------+------------------+
| *Setter* | set_shape(value) |
+-----------+------------------+
| *Getter* | get_shape() |
+-----------+------------------+
.. container:: contribute
There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
----
.. _class_RibbonTrailMesh_property_size:
- :ref:`float<class_float>` **size**
+-----------+-----------------+
| *Default* | ``1.0`` |
+-----------+-----------------+
| *Setter* | set_size(value) |
+-----------+-----------------+
| *Getter* | 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.)`